Initial readthedocs config #339
Conversation
Lasall
force-pushed
the
dl_dev-readthedocs2
branch
from
c0b5f30 to
11eb951
Compare
docs/akkudoktoreos/serverapi.md
Outdated
| @@ -3,5 +3,5 @@ | |||
| # Server API | |||
|
|
|||
| ```{eval-sh} | |||
| ./scripts/generate_openapi_md.py | ./scripts/extract_markdown.py --input-stdin --start-line "**Version**:" | |||
| python ${READTHEDOCS_REPOSITORY_PATH:-.}/scripts/generate_openapi_md.py | python ${READTHEDOCS_REPOSITORY_PATH:-.}/scripts/extract_markdown.py --input-stdin --start-line "**Version**:" | |||
There was a problem hiding this comment.
On a local build this will use the platform python and not the one from .venv. Did you try without python? Every script has a shebang and is executable. Doesn't this work on ReadTheDocs?
There was a problem hiding this comment.
Had to add python because readthedocs (also the execution path there is in the docs dir). I just realized when you pointed out the shebang, that I think it won't work on windows (i think the path there is .venv/Scripts/xyz).
There was a problem hiding this comment.
Ah, the path is probably why the shebang doesn't work on readthedocs (execution in .../docs so it doesn't have the .venv/xyz there). But I would probably change the shebang to just use python as there is a difference depending on platform.
There was a problem hiding this comment.
Don't change the shebang, instead cd to ${READTHEDOCS_REPOSITORY_PATH}/.. when on ReadTheDocs.
There was a problem hiding this comment.
python won't work in my Python Windows installation at work. There I would have to use py or px.exe. Shebangs anyway do not work on Windows, except #!/usr/bin/pythonwhich is somehow handled by the Windows Python installation.
There was a problem hiding this comment.
I'll try how to make it work. I think the venv for readthedocs is also in a different dir.
There was a problem hiding this comment.
Added #341 to avoid problems with ReadTheDocs (and Windows). You may use as a base for your change.
Lasall
force-pushed
the
dl_dev-readthedocs2
branch
2 times, most recently
from
5fa2d85 to
8996d76
Compare
Makefile
Outdated
| @@ -53,7 +53,9 @@ dist: pip | |||
|
|
|||
| # Target to generate HTML documentation | |||
| docs: pip-dev | |||
| .venv/bin/sphinx-build -M html docs build/docs | |||
| . .venv/bin/activate; \ | |||
There was a problem hiding this comment.
Instead of activating the environment you may just make install a dependency.
* Add links to documentation. * Drop unused file class_soc_calc.
Lasall
force-pushed
the
dl_dev-readthedocs2
branch
from
8996d76 to
66686b1
Compare
Lasall
merged commit 10acc70
into
Akkudoktor-EOS:feature/config-overhaul
See example project at https://test-eos.readthedocs.io/en/latest/