Closed alphaville closed 1 year ago
New GitHub Action which
api-dox
sphinx-apidoc
make html
gh-pages
Moreover,
.nojekyll
test
To create the documentation locally, do the following:
pip install sphinx pip install sphinx-rtd-theme
pip install .
sphinx-dox
sphinx-apidoc -o ./source/ ../open-codegen/opengen ../open-codegen/opengen/test/ make html
:children_crossing: this job will only run if the commit is on the master branch or if the commit message contains [docit]
[docit]
Main Changes :construction:
New GitHub Action which
api-dox
sphinx-apidoc
andmake html
gh-pages
to be deployedMoreover,
.nojekyll
to gh-pagestest
was moved outside the main source folderTo create the documentation locally, do the following:
pip install .
)sphinx-dox
and run:children_crossing: this job will only run if the commit is on the master branch or if the commit message contains
[docit]
Associated Issues :lady_beetle:
Checklist :tractor: