Added files
This commit is contained in:
commit
167754b31d
4 changed files with 89 additions and 0 deletions
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
src/
|
||||||
|
docs/*
|
||||||
4
docs/index.md
Normal file
4
docs/index.md
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
# Welcome to Paramecio 2 Library Documentation
|
||||||
|
|
||||||
|
Welcome to the Paramecio2 documentation, from here you can consult the different functions and classes to have quick access to databases, Mako templates, etc.
|
||||||
|
|
||||||
43
mkdocs.yml
Normal file
43
mkdocs.yml
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
site_name: Paramecio2 Docs
|
||||||
|
|
||||||
|
theme:
|
||||||
|
name: material
|
||||||
|
palette:
|
||||||
|
|
||||||
|
# Palette toggle for automatic mode
|
||||||
|
- media: "(prefers-color-scheme)"
|
||||||
|
toggle:
|
||||||
|
icon: material/brightness-auto
|
||||||
|
name: Switch to light mode
|
||||||
|
|
||||||
|
# Palette toggle for light mode
|
||||||
|
- media: "(prefers-color-scheme: light)"
|
||||||
|
scheme: default
|
||||||
|
toggle:
|
||||||
|
icon: material/brightness-7
|
||||||
|
name: Switch to dark mode
|
||||||
|
|
||||||
|
# Palette toggle for dark mode
|
||||||
|
- media: "(prefers-color-scheme: dark)"
|
||||||
|
scheme: slate
|
||||||
|
toggle:
|
||||||
|
icon: material/brightness-4
|
||||||
|
name: Switch to system preference
|
||||||
|
|
||||||
|
|
||||||
|
plugins:
|
||||||
|
- search
|
||||||
|
- gen-files:
|
||||||
|
scripts:
|
||||||
|
- scripts/gen_ref_pages.py #
|
||||||
|
- literate-nav:
|
||||||
|
nav_file: SUMMARY.md
|
||||||
|
- section-index
|
||||||
|
- mkdocstrings
|
||||||
|
|
||||||
|
nav:
|
||||||
|
# rest of the navigation...
|
||||||
|
# defer to gen-files + literate-nav
|
||||||
|
- Code Reference: reference/ #
|
||||||
|
# rest of the navigation...
|
||||||
|
- Index: index.md
|
||||||
40
scripts/gen_ref_pages.py
Normal file
40
scripts/gen_ref_pages.py
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
"""Generate the code reference pages."""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import mkdocs_gen_files
|
||||||
|
|
||||||
|
nav = mkdocs_gen_files.Nav()
|
||||||
|
|
||||||
|
for path in sorted(Path("src/paramecio2/libraries").rglob("*.py")): #
|
||||||
|
print(path)
|
||||||
|
module_path = path.relative_to("src").with_suffix("") #
|
||||||
|
|
||||||
|
doc_path = path.relative_to("src").with_suffix(".md") #
|
||||||
|
|
||||||
|
|
||||||
|
full_doc_path = Path("reference", doc_path) #
|
||||||
|
|
||||||
|
parts = list(module_path.parts)
|
||||||
|
|
||||||
|
if parts[-1] == "__init__": #
|
||||||
|
parts = parts[:-1]
|
||||||
|
doc_path = doc_path.with_name("index.md")
|
||||||
|
full_doc_path = full_doc_path.with_name("index.md")
|
||||||
|
|
||||||
|
elif parts[-1] == "__main__":
|
||||||
|
continue
|
||||||
|
|
||||||
|
nav[parts] = doc_path.as_posix() #
|
||||||
|
|
||||||
|
with mkdocs_gen_files.open(full_doc_path, "w") as fd: #
|
||||||
|
identifier = ".".join(parts) #
|
||||||
|
|
||||||
|
print("::: " + identifier, file=fd) #
|
||||||
|
|
||||||
|
mkdocs_gen_files.set_edit_path(full_doc_path, path) #
|
||||||
|
#mkdocs_gen_files.set_edit_path(full_doc_path, Path("../") / path) #
|
||||||
|
|
||||||
|
|
||||||
|
with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file: #
|
||||||
|
nav_file.writelines(nav.build_literate_nav()) #
|
||||||
Loading…
Add table
Add a link
Reference in a new issue