b0ec91e69e
* Some framework for docs * Separate CSS file for our site-specific CSS. * Override the read-the-docs theme for tables so that tables don't always horizontally scroll * Add a |br| substitution that lets us line break inside of tables * Add |_| non-breaking-space substitution which is also for formatting tables * Configure rstcheck to ignore all substitutions which are being added by sphinx in the conf.py * Fix table of auto interpreter options The table was being hardcoded at a certain width to work around a read-the-docs theme bug. Fix the bug instead and format the table using better sphinx practices. * Remove unused substitutions We had substitutions defined that were never used in our documentation. Remove those. Also add to the rstcheck whitelist three substitutions which are defined by sphinx itself, version, release, and today. |
5 years ago | |
---|---|---|
.. | ||
_extensions | 5 years ago | |
_static | 5 years ago | |
_themes/sphinx_rtd_theme | 5 years ago | |
js/ansible | 8 years ago | |
rst | 5 years ago | |
.gitignore | 7 years ago | |
.nojekyll | 8 years ago | |
Makefile | 5 years ago | |
Makefile.sphinx | 7 years ago | |
README.md | 6 years ago | |
jinja2-2.9.7.inv | 7 years ago | |
keyword_desc.yml | 5 years ago | |
modules.js | 8 years ago | |
python2-2.7.13.inv | 7 years ago | |
python3-3.6.2.inv | 7 years ago | |
requirements.txt | 5 years ago | |
variables.dot | 8 years ago |
README.md
Homepage and Documentation Source for Ansible
This project hosts the source behind docs.ansible.com
Contributions to the documentation are welcome. To make changes, submit a pull request that changes the reStructuredText files in the rst/
directory only, and the core team can do a docs build and push the static files.
If you wish to verify output from the markup such as link references, you may install sphinx and build the documentation by running make webdocs
from the ansible/docs/docsite
directory.
To include module documentation you'll need to run make webdocs
at the top level of the repository. The generated html files are in docsite/htmlout/
.
To limit module documentation building to a specific module, run MODULES=NAME make webdocs
instead. This should make testing module documentation syntax much faster. Instead of a single module, you can also specify a comma-separated list of modules. In order to skip building documentation for all modules, specify non-existing module name, for example MODULES=none make webdocs
.
If you do not want to learn the reStructuredText format, you can also file issues about documentation problems on the Ansible GitHub project.
Note that module documentation can actually be generated from a DOCUMENTATION docstring in the modules directory, so corrections to modules written as such need to be made in the module source, rather than in docsite source.
To install sphinx and the required theme, install pip
and then pip install sphinx sphinx_rtd_theme
HEADERS
RST allows for arbitrary hierarchy for the headers, it will 'learn on the fly'. We also want a standard that all our documents can follow:
##########################
# with overline, for parts
##########################
*****************************
* with overline, for chapters
*****************************
=, for sections
===============
-, for subsections
------------------
^, for sub-subsections
^^^^^^^^^^^^^^^^^^^^^
", for paragraphs
"""""""""""""""""
We do have pages littered with ```````` headers, but those should be removed for one of the above.