IBM / z_ansible_collections_doc

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

Errors in raw make file usage when buldiing docs #35

Closed ddimatos closed 1 year ago

ddimatos commented 1 year ago

While the playbooks are nice, they do have an issue in that they can eat the errors that Sphynx generates. I assume these have been here well over a year, probably closer to 2 yrs. Anyhow when running the make file to visually see the STDOUT, i noticed a number of errors: (venv) make clean;make module-doc;make html;make view-html;

updating environment: [new config] 114 added, 0 changed, 0 removed
reading sources... [100%] zhmc-ansible-modules/docs/source/requirements_managed
/Users/ddimatos/git/github/z_ansible_collections_doc/source/Troubleshooting/errorsandmessages.rst:63: ERROR: Unknown target name: "release notes".
/Users/ddimatos/git/github/z_ansible_collections_doc/source/Troubleshooting/errorsandmessages.rst:120: ERROR: Unknown target name: "installation doc".
/Users/ddimatos/git/github/z_ansible_collections_doc/source/ibm_zos_core/docs/source/modules/zos_apf.rst:125: 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
/Users/ddimatos/git/github/z_ansible_collections_doc/source/ibm_zos_core/CHANGELOG.rst: WARNING: document isn't included in any toctree
/Users/ddimatos/git/github/z_ansible_collections_doc/source/ibm_zos_ims/CHANGELOG.rst: WARNING: document isn't included in any toctree
/Users/ddimatos/git/github/z_ansible_collections_doc/source/ibm_zos_sysauto/CHANGELOG.rst: WARNING: document isn't included in any toctree
/Users/ddimatos/git/github/z_ansible_collections_doc/source/ibm_zosmf/CHANGELOG.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
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
generating indices... genindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 10 warnings.

The HTML pages are in build/html.
====================================================================
Completed HTML generation, see /Users/ddimatos/git/github/z_ansible_collections_doc/build/html; next run 'make view-html'
====================================================================
Display generated HTML 'build/html/index.html' in default browser.
(venv) git status
On branch main
Your branch is up to date with 'origin/main'.

Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
    modified:   .gitmodules
    new file:   source/ibm_zos_cics
    new file:   source/ibm_zos_core
    new file:   source/ibm_zos_ims
    new file:   source/ibm_zos_sysauto
    new file:   source/ibm_zosmf
    new file:   source/zhmc-ansible-modules

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
    modified:   inventory
    modified:   source/ibm_zos_core (new commits)
    modified:   source/ibm_zos_ims (new commits)
    modified:   source/ibm_zos_sysauto (new commits)
    modified:   source/ibm_zosmf (new commits)
    modified:   source/zhmc-ansible-modules (new commits)

Untracked files:
  (use "git add <file>..." to include in what will be committed)
    build/
ddimatos commented 1 year ago

After my changes the errors are reduced down to:

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

2)  /Users/ddimatos/git/github/z_ansible_collections_doc/source/ibm_zos_core/CHANGELOG.rst: WARNING: document isn't included in any toctree
3) /Users/ddimatos/git/github/z_ansible_collections_doc/source/ibm_zos_ims/CHANGELOG.rst: WARNING: document isn't included in any toctree
4) /Users/ddimatos/git/github/z_ansible_collections_doc/source/ibm_zos_sysauto/CHANGELOG.rst: WARNING: document isn't included in any toctree
5) /Users/ddimatos/git/github/z_ansible_collections_doc/source/ibm_zosmf/CHANGELOG.rst: WARNING: document isn't included in any toctree

6) /Users/ddimatos/git/github/z_ansible_collections_doc/source/zhmc-ansible-modules/docs/source/development.rst:44: WARNING: undefined label: supported environments

1) is a known and accepted issue, its because of the escaping in the module that causes this, I have not found a solution 2 - 5) are new because of the unused changelog RST that is required for the collection, a skip list in the config probably can handle these thus for now are accepted 6) there is a git issue opened on it

ddimatos commented 1 year ago

After more changes we are down to just issues (1) and (6), 2 - 5 are gone.