瀏覽代碼

Relocate docs and update table

Valentin Niess 4 年之前
父節點
當前提交
24c5f0e7c4

+ 0 - 0
docs/main.py → docs/include/macros.py


+ 4 - 1
docs/mkdocs.yml

@@ -4,7 +4,9 @@ site_author: Valentin Niess
 copyright: GPL-3.0
 
 repo_url: https://github.com/niess/python-appimage/
-edit_uri: edit/master/docs/
+edit_uri: edit/master/docs/src
+
+docs_dir: src
 
 nav:
   - Python AppImages: index.md
@@ -18,6 +20,7 @@ theme:
 plugins:
   - macros:
       include_dir: docs/include
+      module_name: include/macros
   - search
 
 markdown_extensions:

+ 0 - 2
docs/docs/apps.md → docs/src/apps.md

@@ -154,7 +154,6 @@ environement variables][APPIMAGE_ENV] can be used as well, if needed. For
 example, `$APPDIR` points to the AppImage mount point at runtime.
 {% endraw %}
 
-{{ begin("#entrypoint-variables") }}
 | variable             | Description                                                   |
 |----------------------|---------------------------------------------------------------|
 | `architecture`       | The AppImage architecture, e.g. `x86_64`.                     |
@@ -163,7 +162,6 @@ example, `$APPDIR` points to the AppImage mount point at runtime.
 | `python-fullversion` | The Python full version string, e.g. `3.10.2`.                |
 | `python-tag`         | The Python compatibility tag, e.g. `cp310-cp310`.             |
 | `python-version`     | The Python short version string, e.g. `3.10`.                 |
-{{ end("#entrypoint-variables") }}
 {{ end(".capsule") }}
 
 {% raw %}

+ 33 - 0
docs/docs/css/extra.css → docs/src/css/extra.css

@@ -96,3 +96,36 @@ pre code.hljs {
     height: 18px;
     width: auto;
 }
+
+/* Reshape tables */
+.rst-content .section .docutils {
+    border-collapse: collapse;
+    box-shadow: 0 0 20px rgba(0, 0, 0, 0.15);
+    caption-side: bottom;
+    display: table;
+    margin-left: auto;
+    margin-right: auto;
+}
+
+.rst-content table.docutils thead {
+    background-color: #2e3440;
+    color: #d8dee9;
+    text-align: left;
+    vertical-align: middle;
+}
+
+.rst-content table.docutils tbody tr {
+    border-bottom: 1px solid #dddddd;
+}
+
+.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td {
+    background-color: white;
+}
+
+.rst-content table.docutils tbody tr:nth-of-type(even) {
+    background-color: #f3f3f3;
+}
+
+.rst-content table.docutils tbody tr:last-of-type {
+    border-bottom: 2px solid #2e3440;
+}

+ 0 - 0
docs/docs/css/nord.min.css → docs/src/css/nord.min.css


+ 0 - 0
docs/docs/index.md → docs/src/index.md


+ 0 - 0
docs/docs/js/apps.js → docs/src/js/apps.js


+ 0 - 0
docs/docs/js/highlight.min.js → docs/src/js/highlight.min.js


+ 0 - 0
docs/docs/js/index.js → docs/src/js/index.js