Add autodocs boilerplate #1108
Merged
Add autodocs boilerplate #1108
+297
−2
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1108 +/- ##
=======================================
Coverage 95.45% 95.45%
=======================================
Files 54 54
Lines 4733 4733
Branches 836 836
=======================================
Hits 4518 4518
Misses 132 132
Partials 83 83
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Venefilyn
reviewed
Feb 22, 2024
Venefilyn
reviewed
Mar 5, 2024
Venefilyn
reviewed
Apr 17, 2024
Comment on lines
+4
to
+13
| # You can set these variables from the command line, and also | ||
| # from the environment for the first two. | ||
| SPHINXOPTS ?= | ||
| SPHINXBUILD ?= sphinx-build | ||
| SOURCEDIR = source | ||
| BUILDDIR = build | ||
|
|
||
| # Put it first so that "make" without argument is like "make help". | ||
| help: | ||
| @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
There was a problem hiding this comment.
Also just in general would be great to have this generated in a container so it's reproducible on all machines
bookwar
added
the
tests-skip
bookwar
added
no-changelog
This patch adds the initial setup if the Python Sphinx Autodocs. We use autosummary extension to generate recursively the tree of all modules, classes and functions. Then we additionally add two pages (actions.rst and pkgmanager.rst) to show the possibility to add custom content to the autogenerated documentation. To build the docs you need python3-sphinx python3-sphinx-autodoc-typehints installed on the environment (via dnf or pip)
Venefilyn
approved these changes
May 23, 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.
This patch adds autodocs skeleton without adding any automation to generate the docs.
Checklist
[RHELC-]is part of the PR titleRelease Pendingif relevant