Minor doc improvements #130
Merged
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
andy-maier
force-pushed
the
andy/doc-fixes
branch
2 times, most recently
from
7dbfe47
to
5ef158f
Compare
andy-maier
force-pushed
the
andy/doc-fixes
branch
from
5ef158f
to
a5d1102
Compare
KSchopmeyer
approved these changes
Jan 16, 2023
|
Approved al the changes themselves, Obviously there is the issue of it failing tests. :) |
andy-maier
force-pushed
the
andy/doc-fixes
branch
from
a5d1102
to
a921e14
Compare
|
The linkcheck error was caused by this issue sphinx-doc/sphinx#11041 and I resolved it by removing the # anchor in the link. |
Details: * Simplified the Installation section by merging a subchapter into the Installation chapter. * Corrected the set of tested OS environments to no longer contain CygWin. * Removed the prerequisites packages setuptools, pip and wheel for installation, since pip does not have any requirements on setuptools or wheel. * Removed the "Python namespace" section and moved the statement about describing only the external API to the begin of the "API Reference" section. * Specified language 'en' for the docs building in conf.py, to eliminate a corresponding warning during docs building. * Generalized the version 3.4 to 3 in the link to the Python 3 glossary. * Added 'make doclinkcheck' to the GitHub Actions test workflow, and documented this make target in 'make help' and added it to 'make all'. Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
andy-maier
force-pushed
the
andy/doc-fixes
branch
from
a921e14
to
9803e24
Compare
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.