cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Moved generated module RSTs to their own directory. (#33966)

Browse source 
* Moved generated module RSTs to their own directory.

* WIP commit - fixed conflict with conf.py exclude_patterns by renaming module RST output directory to 'module_docs'.

* Added new directory to formatter module links; aded new module directory to makefile clean.

* Removed illegal comment from block.
This commit is contained in:
scottb 2017-12-21 01:47:39 -08:00 committed by GitHub
parent 60f3649ebd
commit f8f34c7bab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/bin/plugin_formatter.py
View file

@ -58,7 +58,7 @@ from ansible.utils.display import Display
# if a module is added in a version of Ansible older than this, don't print the version added information # if a module is added in a version of Ansible older than this, don't print the version added information
# in the module documentation because everyone is assumed to be running something newer than this already. # in the module documentation because everyone is assumed to be running something newer than this already.
TO_OLD_TO_BE_NOTABLE = 1.3 TOO_OLD_TO_BE_NOTABLE = 1.3
# Get parent directory of the directory this script lives in # Get parent directory of the directory this script lives in
MODULEDIR = os.path.abspath(os.path.join( MODULEDIR = os.path.abspath(os.path.join(
@ -88,7 +88,7 @@ def rst_ify(text):
try: try:
t = _ITALIC.sub(r'*' + r"\1" + r"*", text) t = _ITALIC.sub(r'*' + r"\1" + r"*", text)
t = _BOLD.sub(r'**' + r"\1" + r"**", t) t = _BOLD.sub(r'**' + r"\1" + r"**", t)
t = _MODULE.sub(r':ref:`' + r"\1 <\1>" + r"`", t) t = _MODULE.sub(r':ref:`module_docs/' + r"\1 <\1>" + r"`", t)
t = _URL.sub(r"\1", t) t = _URL.sub(r"\1", t)
t = _CONST.sub(r'``' + r"\1" + r"``", t) t = _CONST.sub(r'``' + r"\1" + r"``", t)
except Exception as e: except Exception as e:
@ -319,7 +319,7 @@ def too_old(added):
except ValueError as e: except ValueError as e:
warnings.warn("Could not parse %s: %s" % (added, str(e))) warnings.warn("Could not parse %s: %s" % (added, str(e)))
return False return False
return added_float < TO_OLD_TO_BE_NOTABLE return added_float < TOO_OLD_TO_BE_NOTABLE
def process_plugins(module_map, templates, outputname, output_dir, ansible_version, plugin_type): def process_plugins(module_map, templates, outputname, output_dir, ansible_version, plugin_type):

3
docs/docsite/Makefile
View file

@ -45,6 +45,7 @@ webdocs: docs
#TODO: leaving htmlout removal for those having older versions, should eventually be removed also #TODO: leaving htmlout removal for those having older versions, should eventually be removed also
clean: clean:
-rm -rf htmlout -rm -rf htmlout
-rm -rf module_docs
-rm -rf _build -rm -rf _build
-rm -f .buildinfo -rm -f .buildinfo
-rm -f objects.inv -rm -f objects.inv
@ -82,7 +83,7 @@ config:
PYTHONPATH=../../lib $(CONFIG_DUMPER) --template-file=../templates/config.rst.j2 --output-dir=rst/ -d ../../lib/ansible/config/base.yml PYTHONPATH=../../lib $(CONFIG_DUMPER) --template-file=../templates/config.rst.j2 --output-dir=rst/ -d ../../lib/ansible/config/base.yml
modules: $(FORMATTER) ../templates/plugin.rst.j2 modules: $(FORMATTER) ../templates/plugin.rst.j2
PYTHONPATH=../../lib $(FORMATTER) -t rst --template-dir=../templates --module-dir=../../lib/ansible/modules -o rst/ $(MODULE_ARGS) PYTHONPATH=../../lib $(FORMATTER) -t rst --template-dir=../templates --module-dir=../../lib/ansible/modules -o rst/module_docs/ $(MODULE_ARGS)
plugins: $(FORMATTER) ../templates/plugin.rst.j2 plugins: $(FORMATTER) ../templates/plugin.rst.j2
@echo "looping over doc plugins" @echo "looping over doc plugins"

4
docs/docsite/rst/index.rst
View file

@ -23,14 +23,14 @@ Ansible, Inc. releases a new major release of Ansible approximately every two mo
.. _an_introduction: .. _an_introduction:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
intro intro
quickstart quickstart
playbooks playbooks
playbooks_special_topics playbooks_special_topics
modules modules
modules_by_category module_docs/modules_by_category
vault vault
command_line_tools command_line_tools
plugins_by_category plugins_by_category