spiri-sdk/docs
Alex Davies b61a389b92 feat: Include README.md in Sphinx documentation with myst-parser 2024-10-16 10:52:35 -03:00
..
source feat: Include README.md in Sphinx documentation with myst-parser 2024-10-16 10:52:35 -03:00
Makefile Update docs 2024-10-16 09:13:46 -03:00
README.md Update docs 2024-10-16 09:13:46 -03:00
make.bat Update docs 2024-10-16 09:13:46 -03:00

README.md

If you have a correctly configured sphinx environment you can build this project using make html latexpdf.

You can also use nektos/act to build this project in the same way our build does.

cd ../ #Make sure you're in the project root, you should have a hidden folder
# named ./.github/workflows available.
act --artifact-server-path ./doc-build

Your compiled doc project will now be in the ./doc-build folder.