Docs build: Resolved ref not found warnings; build without package install #2895
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…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
added
the
roll back/forward done
This was referenced Jun 20, 2022
This was referenced Jun 30, 2022
This was referenced Jul 17, 2022
This was referenced Jul 18, 2023
This was referenced Sep 3, 2023
This was referenced Nov 5, 2023
This was referenced Nov 18, 2023
This was referenced Dec 30, 2023
This was referenced Feb 5, 2024
This was referenced Mar 13, 2024
This was referenced Mar 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For details, see the commit message.
No review needed.