Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-08-25 23:11:14 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Adapt documentation generation to be compliant to ReadTheDocs and Windows. (#341)

Browse Source 
Use documentation generation tools that are available for Windows and Linux.
Use python instead of shell scripts to generate documentation.

For ReadTheDocs make generated documentation content static to avoid
running scripts outside of the docs/ path which is the default path for ReadTheDOcs.

Add tests that check if generated content does go out of sync with latest source.

Use tabs to show commands for Windows and Linux to improve user experience.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
This commit is contained in:
Bobby Noelte
2025-01-06 16:27:57 +01:00
committed by GitHub
parent d4e31d556a
commit 214768795f
15 changed files with 9586 additions and 9050 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/conf.py
View File

@@ -24,7 +24,7 @@ extensions = [
"sphinx.ext.napoleon",
"sphinx_rtd_theme",
"myst_parser",
"sphinxcontrib.eval",
"sphinx_tabs.tabs",
]
templates_path = ["_templates"]