Usage and API documentation for Autofac and integration libraries.
Check out the Autofac documentation at docs.autofac.org!
User documentation is viewable at https://docs.autofac.org
(a CNAME to https://autofac.readthedocs.org).
It is stored in the /docs
folder in this source repo.
To build the docs and see them locally, you need to follow the Getting Started docs on Read The Docs so you get Python and Sphinx installed.
The docs are written in reStructuredText, which is very similar to Markdown but not quite. References below.
Updates to the documentation checked into the /docs
folder will automatically
propagate to Read The Docs. No build or separate push is required.
- Install Python 2.7
- Install Sphinx:
pip install sphinx sphinx-autobuild
- Build the docs after you edit them. There should be NO errors or warnings:
make.bat html