We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
We should revisit hooking up documentation generation via hugo to the CI pipelines at some point.
Also documenting how to do it even if it's still manual.
Originally posted by @bpkroth in #14 (comment)
The text was updated successfully, but these errors were encountered:
I'll write proper documentation on this later, but for now the process is:
Install hugo and build the hugo part of the site:
sudo apt-get install hugo cd website ./build_site.sh rm -rf public/* hugo
install sphinx and build the sphinx part of the site:
cd sphinx pip install sphinx sphinx-rtd-theme numpydoc make
Copy the sphinx part into the hugo part:
cp -r _build/html/ ../public/python_api
The easiest way to push the website that now lives in website/public to github is with
website/public
git worktree add -B gh-pages website/public upstream/gh-pages
If a new class was added, you also need to run the sphinx source generation with
./apidoc.sh
and then reset some files with
git checkout .
easy-peasy!
Sorry, something went wrong.
@amueller this got done in #50 right? I guess #55 is related as well.
This got started in #50. #61 applies some additional fixups and extends it to include link checking as well.
No branches or pull requests
We should revisit hooking up documentation generation via hugo to the CI pipelines at some point.
Also documenting how to do it even if it's still manual.
Originally posted by @bpkroth in #14 (comment)
The text was updated successfully, but these errors were encountered: