Where is the webdocs file?

Archives Ansible Developer
1

Based on http://python.usyiyi.cn/documents/Ansible/ansible/dev_guide/developing_modules_documenting.html#testing-documentation

But where is the webdocs file?

Thanks
Jae Kim

2

Some replied “There isn’t a file named webdocs, it’s just a make target.”
Then under which director should the command be run?
When it is run under below, it says.

[root@localhost network]# pwd
/usr/lib/python2.7/site-packages/ansible/modules/network
[root@localhost network]# make webdoc
make: *** No rule to make target `webdoc’. Stop.

3

It should be run from a checkout of the source repository. The dev_guide documentation anticipate that you are developing ansible and working from a checkout.

-Toshio

4

Hi

It gets stuck at this point

label: ansible_executable (if the link has no caption the label must precede a section header)
/root/work/ansible_git/ansible/docs/docsite/rst/plugins/strategy.rst:37: WARNING: undefined label: strategy (if the link has no caption the label must precede a section header)
/root/work/ansible_git/ansible/docs/docsite/rst/plugins/vars.rst:11: WARNING: undefined label: host_vars (if the link has no caption the label must precede a section header)
/root/work/ansible_git/ansible/docs/docsite/rst/plugins/vars.rst:11: WARNING: undefined label: group_vars (if the link has no caption the label must precede a section header)
/root/work/ansible_egit/ansible/docs/docsite/rst/porting_guide_2.0.rst:242: WARNING: py:attr reference target not found: self.playbook
/root/work/ansible_git/ansible/docs/docsite/rst/porting_guide_2.0.rst:242: WARNING: py:attr reference target not found: self.play
/root/work/ansible_git/ansible/docs/docsite/rst/porting_guide_2.0.rst:242: WARNING: py:attr reference target not found: self.task
/root/work/ansible_git/ansible/docs/docsite/rst/porting_guide_2.5.rst:46: WARNING: undefined label: fixme (if the link has no caption the label must precede a section header)
/root/work/ansible_git/ansible/docs/docsite/rst/python_3_support.rst:78: WARNING: unknown option: -e
/root/work/ansible_git/ansible/docs/docsite/rst/release_and_maintenance.rst:16: WARNING: undefined label: schedule (if the link has no caption the label must precede a section header)
writing output… [100%] win_wait_for_module … zypper_repository_module
waiting for workers…

5

Also this error was seen previous to this one

WARNING: intersphinx inventory ‘https://docs.python.org/2/objects.inv’ not fetch able due to <class ‘requests.exceptions.SSLError’>: HTTPSConnectionPool(host=‘do cs.python.org’, port=443): Max retries exceeded with url: /2/objects.inv (Caused by SSLError(SSLError(1, ‘[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify fa iled (_ssl.c:600)’),))
loading intersphinx inventory from …/python2-2.7.13.inv…
loading intersphinx inventory from https://docs.python.org/3/objects.inv…
WARNING: intersphinx inventory ‘https://docs.python.org/3/objects.inv’ not fetch able due to <class ‘requests.exceptions.SSLError’>: HTTPSConnectionPool(host=‘do cs.python.org’, port=443): Max retries exceeded with url: /3/objects.inv (Caused by SSLError(SSLError(1, ‘[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify fa iled (_ssl.c:600)’),))
loading intersphinx inventory from …/python3-3.6.2.inv…
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1732 source files that are out of date
updating environment: 1732 added, 0 changed, 0 removed
reading sources… [ 10%] avi_analyticsprofile_module … azure_rm_virtualmachine reading sources… [ 15%] azure_rm_virtualmachine_scaleset_module … ce_interfac reading sources… [ 21%] ce_ip_interface_module … community/reporting_bugs_and reading sources… [ 78%] plugins/inventory/host_list … proxysql_scheduler_modu reading sources… [100%] win_ping_module … zypper_repository_module

6

This doesn’t seem like it is frozen. How long did you wait for it to finish? Did your CPU continue to be working hard during this time?

There was a Sphinx version that did get stuck when building docs but in general, the docs build does take quite a while. It takes over an hour for me on modern hardware with plenty of ram.

-Toshio

7

Hi

Thanks for your help. I waited and the process completed.
I was wondering if there is a way to have it partially updated with newly added custom or community Ansible module.
I add new files and executed it. It seems to run the whole process again.

Thanks
Jae Kim

8

Hi

Also during the process I noticed a connection error message

WARNING: intersphinx inventory ‘https://docs.python.org/2/objects.inv’ not fetch able due to <class ‘requests.exceptions.SSLError’>: HTTPSConnectionPool(host=‘do cs.python.org’, port=443): Max retries exceeded with url: /2/objects.inv (Caused by SSLError(SSLError(1, ‘[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify fa iled (_ssl.c:600)’),))
loading intersphinx inventory from …/python2-2.7.13.inv…
loading intersphinx inventory from https://docs.python.org/3/objects.inv…
WARNING: intersphinx inventory ‘https://docs.python.org/3/objects.inv’ not fetch able due to <class ‘requests.exceptions.SSLError’>: HTTPSConnectionPool(host=‘do cs.python.org’, port=443): Max retries exceeded with url: /3/objects.inv (Caused by SSLError(SSLError(1, ‘[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify fa iled (_ssl.c:600)’),))

This seems to have occurred as we are behind a firewall. Is there a way to set a proxy or add trusted site in this command?

Thanks
Jae KIm

9

If you want to just generate the docs for just a single module you can run

MODULES=file make webdocs

This will generate the docs for the file module as well as the rest of the rst docs. This will save a lot of time as you don’t need to generate the docs for every single module.

Thanks

Jordan