At Teracy, all our documentations are written with the help from
sphinx1. It’s easy to setup and
manage. However, we could not find a good enough deployment solution for
project. What does “good enough” here means? It means:
The installation and configuration should be easy with
gitand command line.
The deployment could be “decoupled” from
sphinxproject for easy upgrade and maintenance. It’s better if we could have this deployment solution provided by
sphinxout of the box.
The usage should be easy like:
$ make setupto setup deployment basing on the configurations
$ make generateto generate content basing on the configurations
$ make deployto deploy the project basing on the configurations
We could not find a solution good enough meeting our requirements, so we created sphinx-deployment project that implements the ideas and requirements above.
There are many things that we need to do, please help use to shape the project’s future by
pull requests or giving your ideas. Your contributions
are all welcome. Please head to the development branch at
Have a nice day and happy hacking!