search

IBM / z_ansible_collections_doc

Repository for Z collections documentation
Apache License 2.0
8 stars 8 forks source link

Documentation appears to not be present when HTML is generated from RST #25

Open ddimatos opened 2 years ago

ddimatos commented 2 years ago

When you run the playbook to generate doc, some errors are masked vs when you use the make file; for example: ansible-playbook -i inventory site-builder.yml vs make clean; make html; make view-html

When using make clean; make html; make view-html you will see more detailed errors and till now, there have been 2 accepted known errors but the list has grown.

New errors that can likely be resolved:

reading sources... [100%] zhmc-ansible-modules/docs/source/requirements_managed
/Users/ddimatos/git/github/z_ansible_collections_doc/source/Troubleshooting/errorsandmessages.rst:63: WARNING: Unknown target name: "release notes".
/Users/ddimatos/git/github/z_ansible_collections_doc/source/Troubleshooting/errorsandmessages.rst:120: WARNING: Unknown target name: "installation doc".
/Users/ddimatos/git/github/z_ansible_collections_doc/source/ibm_zos_core/docs/source/modules/zos_apf.rst:124: WARNING: Inline emphasis start-string without end-string.
/Users/ddimatos/git/github/z_ansible_collections_doc/source/index.rst:48: WARNING: toctree contains reference to nonexisting document 'troubleshooting/errorsandmessages'
looking for now-outdated files... none found
pickling environment... done
checking consistency... /Users/ddimatos/git/github/z_ansible_collections_doc/source/Troubleshooting/errorsandmessages.rst: WARNING: document isn't included in any toctree

This one from the above list is an accepted and known issue but the others above could be resolved.

/Users/ddimatos/git/github/z_ansible_collections_doc/source/ibm_zos_core/docs/source/modules/zos_apf.rst:124: WARNING: Inline emphasis start-string without end-string.

One more new one further down in the tooling output that can be resolved. 

writing output... [100%] zhmc-ansible-modules/docs/source/requirements_managed
/Users/ddimatos/git/github/z_ansible_collections_doc/source/zhmc-ansible-modules/docs/source/development.rst:44: WARNING: undefined label: supported environments (if the link has no caption the label must precede a section header)
generating indices...  genindexdone
ddimatos commented 2 years ago

@jennyhuang17 - was not able to assign to you, you should have a pending invite now, so when you accept ill assign it to you.

jennyhuang17 commented 2 years ago

@ddimatos Accepted! Thanks for resending the invitation... I think I didn't turn 2FA on and was removed from the collaborator list.