ansible

Commit Graph

Author	SHA1	Message	Date
Sviatoslav Sydorenko	d75d9443fc	Bump sphinx_ansible_theme to v0.7.0+ (#75059 ) This version relies on an external lib implementing lexers and styles. That lib pulls in proper Pygments version so this patch also drops it from direct requirements.	3 years ago
Felix Fontein	2c0f050b4f	Use antsibull sphinx extension (#73170 ) * Use antsibull sphinx extension. * Require antsibull 0.34.0.	3 years ago
Alicia Cozine	58f26388be	Update docs requirements list (#74956 ) * removes upper bound on sphinx version * updates versions of docs build dependencies, adds known good requirements file * adds instructions for using known_good_reqs file	3 years ago
Sviatoslav Sydorenko	346c7a765d	Use `sphinx_ansible_theme` Sphinx theme in docs (#74318 )	4 years ago
Sandra McCann	7443e9d659	pin docutils to 0.16 until theme problem is fixed (#74193 )	4 years ago
Yanis Guenane	212837defc	Documentation: Lay the ground for i18n work. (#73746 ) * Documentation: Lay the ground for i18n work. * Translating both ansible-core and ansible docs requires msgcat (a program from the gettext package). If msgcat is not present, only the ansible-core index file's strings will be extracted for translation. If this is a problem, a short hacking script could be written to take the place of msgcat (merging the various index pot files into a single pot file). Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>	4 years ago
Sandra McCann	0936623901	update the docs requirements versions (#73108 )	4 years ago
Toshio Kuratomi	9dda393d70	Collections docs generation (#59761 ) * Build documentation for Ansible-2.10 (formerly known as ACD). Builds plugin docs from collections whose source is on galaxy The new command downloads collections from galaxy, then finds the plugins inside of them to get the documentation for those plugins. * Update the python syntax checks * docs builds can now require python 3.6+. * Move plugin formatter code out to an external tool, antsibull-docs. Collection owners want to be able to extract docs for their own websites as well. * The jinja2 filters, tests, and other support code have moved to antsibull * Remove document_plugins as that has now been integrated into antsibull-docs * Cleanup and bugfix to other build script code: * The Commands class needed to have its metaclass set for abstractmethod to work correctly * Fix lint issues in some command plugins * Add the docs/docsite/rst/collections to .gitignore as everything in that directory will be generated so we don't want any of it saved in the git repository * gitignore the build dir and remove edit docs link on module pages * Add docs/rst/collections as a directory to remove on make clean * Split the collections docs from the main docs * remove version and edit on github * remove version banner for just collections * clarify examples need collection keyword defined * Remove references to plugin documentation locations that no longer exist. * Perhaps the pages in plugins/.rst should be deprecated altogether and their content moved? If not, perhaps we want to rephrase and link into the collection documentation? * Or perhaps we want to link to the plugins which are present in collections/ansible/builtin? * Remove PYTHONPATH from the build-ansible calls One of the design goals of the build-ansible.py script was for it to automatically set its library path to include the checkout of ansible and the library of code to implement itself. Because it automatically includes the checkout of ansible, we don't need to set PYTHONPATH in the Makefile any longer. * Create a command to only build ansible-base plugin docs * When building docs for devel, only build the ansible-base docs for now. This is because antsibull needs support for building a "devel tree" of docs. This can be changed once that is implemented * When building docs for the sanity tests, only build the ansible-base plugin docs for now. Those are the docs which are in this repo so that seems appropriate for now.	4 years ago
Sayee	38ccfb4a3e	updated requirements file for docs build (#70609 )	4 years ago
Sayee	1d63b6f4f8	updated requirements file for docs build (#70020 )	5 years ago
Toshio Kuratomi	019d078a5a	Move common build code from _build_helpers (#55986 ) We have some common code used by several docs scripts. Migrate that into the build-only shared code repository. * Move lib/ansible/utils/_build_helpers.py to the directory for common build code * Migrate docs/bin/dump_config.py to a build-ansible subcommand * Migrate dump_keywords to the build-ansible framework * Make the script more maintainable by using functions and good variable names * Port to Python3 idioms * Fix bug so that private attributes will be undocumented * Move generate_man to a build-ansible subcommand * Port plugin_formatter to a build-ansible subcommand * Rework command_plugins so that docs scripts can target Python-3.4+ and releng-only subcommands can use more recent versions of Python. The architecture is now that command_plugins/* need to be importable on Python-3.4. The init_parsers() method needs to run on Python-3.4. But the main() method can utilize features of more recent Python as long as it fits within those parameters. * Update docs build requirements Port the plugin_formatter to build-ansible framework	5 years ago
Felix Fontein	505c99265c	docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508 ) * Remove lexers which have been fixed in Pygments 2.4.0. * Add Pygments >= 2.4.0 to test runner. * Fix pages that triggered lexer errors. Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>	6 years ago
Alicia Cozine	e834cd7d41	updates reqs for building docs locally (#57967 )	6 years ago
Sebastian Meyer	3f97abc6e2	Add PyYAML to docs requirements.txt (#53521 ) When building the docs in a virtualenv we need to install PyYAML in addition to sphinx, otherwise the `import yaml` will fail.	6 years ago
Matt Clay	a4c9f57b38	Move docsite requirements to the docs/docsite dir. (#46518 )	6 years ago

15 Commits (ccf8a7da8283e72ae8ad565d80c5a100477ea8d2)