This flake provides a quick way to run a local sphinx server that build the documentation of your project just like it would be built on https://readthedocs.org/.
The idea behind this tool is to have a quick up-and-running tool to generate the project's documentation using Nix.
While being extremely stable for years, "flake" is an upcoming feature of the Nix package manager. In order to use it, you must explicitly enable it, please check the documentation to enable it, this is currently an opt-in option.
To run a local server of your documentation, run:
nix run github:loophp/nix-sphinx#autobuild -- <sourcedir> <outdir>To just build the documentation, run:
nix run github:loophp/nix-sphinx#build -- <sourcedir> <outdir><sourcedir>must be replaced by the directory containing the documentation<outdir>must be replaced by a directory where the documentation will be generated, usually in a directory which is ignored by your source version control.
Feel free to contribute by sending pull requests. We are a usually very responsive team and we will help you going through your pull request from the beginning to the end.
For some reasons, if you can't contribute to the code and willing to help, sponsoring is a good, sound and safe way to show us some gratitude for the hours we invested in this package.
Sponsor me on Github and/or any of the contributors.
See CHANGELOG.md for a changelog based on git commits.
For more detailed changelogs, please check the release changelogs.