You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docs/docsite
Sandra McCann ed21aba442 add link to content collector tool (#59881) 5 years ago
..
_extensions docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508) 5 years ago
_static Autointerpreter table (#60148) 5 years ago
_themes/sphinx_rtd_theme add eol banner (#59254) 5 years ago
js/ansible consolidated docs 8 years ago
rst add link to content collector tool (#59881) 5 years ago
.gitignore Initial ansible-test sanity docs. (#26775) 7 years ago
.nojekyll consolidated docs 8 years ago
Makefile Generate galaxy.yml based on single source of truth (#59170) 5 years ago
Makefile.sphinx Adds the ability to override the doc build output directory from the command line. (#36604) 7 years ago
README.md docs/docsite: minor fixes in docs/docsite/README.md (#55356) 6 years ago
jinja2-2.9.7.inv Update the intersphinx cached indexes 7 years ago
keyword_desc.yml Fix notifying handlers by using an exact match (#55624) 5 years ago
modules.js consolidated docs 8 years ago
python2-2.7.13.inv Update the intersphinx cached indexes 7 years ago
python3-3.6.2.inv Update the intersphinx cached indexes 7 years ago
requirements.txt Move common build code from _build_helpers (#55986) 5 years ago
variables.dot consolidated docs 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.