Documentation improvements

sphinx-contrib / sphinxcontrib-versioning

Sphinx extension that allows building versioned docs for self-hosting.

https://sphinxcontrib-versioning.readthedocs.io/en/latest/

MIT License

125 stars 81 forks source link

Documentation improvements #65

Open saily opened 5 years ago

saily commented 5 years ago

Thank you very much for that great plugin! I think this adds a lot of value but unfortunately it's very complex to get it up and running as most options are not documented at all. Could you please add/extend the documentation to include:

documentation of command line arguments
minimal example how to configure conf.py.
description how tags/branches can be used

Thank a lot.