cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
ansible/docs/docsite
History
Toshio Kuratomi 0da13469d3 Add a script to update the intersphinx inventory (#66646) 
* Add a script to update the intersphinx inventory files

* We're about to add intersphinx inventories for separate ansible docs
  so we need an easy way to update them.  Also, we should be updating
  these cache files for other upstreams occassionally as well.  With a
  script, we can add updating them to a release process.
* Now that we don't know what the version of the cache is, change the
  filenames to not contain versions.

* Update the intersphinx cache files with the latest upstream versions

Results of running:

hacking/build-ansible.py update-intersphinx-cache -o docs/docsite -c docs/docsite/rst/conf.py

* Add a comment to the configuration file which says how to structure the intersphinx mapping and why.

* Update docs/docsite/rst/conf.py

Co-Authored-By: Sandra McCann <samccann@redhat.com>

Co-authored-by: Sandra McCann <samccann@redhat.com>
2020-01-22 17:20:02 -05:00
..
_extensions docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508) 2019-06-18 10:56:33 -05:00
_static Trim down to one Ansible search option (#66284) 2020-01-10 16:31:46 -06:00
_themes/sphinx_rtd_theme Trim down to one Ansible search option (#66284) 2020-01-10 16:31:46 -06:00
js/ansible
rst Add a script to update the intersphinx inventory (#66646) 2020-01-22 17:20:02 -05:00
.gitignore Initial ansible-test sanity docs. (#26775) 2017-07-14 14:24:45 +01:00
.nojekyll
jinja.inv Add a script to update the intersphinx inventory (#66646) 2020-01-22 17:20:02 -05:00
keyword_desc.yml Improve ignore_unreachable documentation (#64938) 2019-11-26 13:35:02 -05:00
Makefile Fix netconf plugin related to collections (#65718) 2019-12-20 12:25:59 +05:30
Makefile.sphinx Adds the ability to override the doc build output directory from the command line. (#36604) 2018-02-28 16:01:18 -08:00
modules.js
python2.inv Add a script to update the intersphinx inventory (#66646) 2020-01-22 17:20:02 -05:00
python3.inv Add a script to update the intersphinx inventory (#66646) 2020-01-22 17:20:02 -05:00
README.md reduce docs/docsite/README to essential info (#64287) 2019-11-01 15:35:40 -05:00
requirements.txt Move common build code from _build_helpers (#55986) 2019-07-16 12:19:01 -07:00
variables.dot

README.md

Ansible documentation

This project hosts the source behind docs.ansible.com.

To create clear, concise, and consistent contributions to Ansible documentation, please refer to the following information.

Contributions

Contributions to the documentation are welcome.

The Ansible community produces guidance on contributions, building documentation, and submitting pull requests, which you can find in Contributing to the Ansible Documentation.

You can also join the Docs Working Group.

Ansible style guide

Ansible documentation is written in ReStructuredText(RST). The Ansible style guide provides linguistic direction and technical guidelines for working with reStructuredText, in addition to other resources.

Tools

The Ansible community uses a range of tools and programs for working with Ansible documentation. Learn more about Other Tools and Programs in the Ansible Community Guide.

GitHub

Ansible documentation is hosted on the Ansible GitHub project. For GitHub workflows and other information, see the GitHub Guides.