Skip to content

Docs build: Resolved ref not found warnings; build without package install#2895

Merged
andy-maier merged 2 commits intomasterfrom
andy/fix-doc-refs
Jun 19, 2022
Merged

Docs build: Resolved ref not found warnings; build without package install#2895
andy-maier merged 2 commits intomasterfrom
andy/fix-doc-refs

Conversation

@andy-maier
Copy link
Copy Markdown
Contributor

For details, see the commit message.
No review needed.

…stall

Details:

* Added the '-n' option to 'sphinx-build' in order to get reference not found
  warnings printed.

* Resolved reference not found warnings. Notable changes:

  - Added class 'pywbem.NocaseDict' to the docs.
  - Added class 'pywbem.MOFWBEMConnection' to the docs, and to the 'pywbem'
    namespace.
  - Added class 'pywbem_mock.CIMNamespaceProvider' to the docs.
  - Moved class 'IterQueryInstancesReturn' that was defined in the scope of
    method 'pywbem.IterQueryInstances' to the 'pywbem' namespace, and added it
    to the docs.

* In 'docs/conf.py', added the main directory of the repo to the Python module
  search path, so the documentation can be built without having the pywbem
  package installed. This is useful for packaging the project as an RPM, for
  example.

* Changed the Intersphinx prefix 'py' from Python 2 to Python 3.

* Changed some uses of the Intersphinx prefix 'py3' to use 'py'.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
Details:

* Some pywbem_mock submodules were missing the '__all__' variable. This caused
  all names defined in and imported into the submodule to become visible in
  the 'pywbem_mock' namespace, which is undesirable.
  Added '__all__' where missing, with only the intended public names.

* Fixed use of incorrectly imported names in unit tests, that were used
  from the 'pywbem_mock' namespace. Used them from their defining submodules.

* Added import of the 'config' submodule into the 'pywbem_mock' namespace,
  in order to make sure that it is impoirted only once wnd that config variables
  can be modified.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
@andy-maier andy-maier added the rollback done Roll back/forward has been done label Jun 19, 2022
@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage increased (+0.007%) to 92.292% when pulling 2614aab on andy/fix-doc-refs into 505d61e on master.

@andy-maier andy-maier merged commit 3d600a5 into master Jun 19, 2022
@andy-maier andy-maier deleted the andy/fix-doc-refs branch June 19, 2022 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rollback done Roll back/forward has been done

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1.4.1 sphinx warnings reference target not found

2 participants