Refactor generating of stories and lint check docs #2441
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
happz
requested review from
psss,
lukaszachy,
thrix,
janhavlin and
martinhoyer
as code owners
happz
force-pushed
the
docs-generate-scripts
branch
6 times, most recently
from
f8cc089
to
7ed6392
Compare
5 tasks
happz
force-pushed
the
docs-generate-scripts
branch
4 times, most recently
from
d517a94
to
98511b6
Compare
happz
commented
Nov 1, 2023
psss
approved these changes
Nov 2, 2023
happz
force-pushed
the
docs-generate-scripts
branch
from
98511b6
to
898dde9
Compare
The code generating rst files from stories and linter sources was part of `docs/conf.py`. Hopefully, there will be more generated rst sources from tmt code, therefore doing a small cleanup: * code generating doc sources from tmt code has been moved into stand-alone scripts, with a bit of docs and polishing. * `docs/Makefile` and `Makefile` have been modified to offer nice help and use the new scripts for generating stuff, in a more make-like fashion, instead of letting `conf.py` control their creation.
psss
force-pushed
the
docs-generate-scripts
branch
from
898dde9
to
6b423be
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.
The code generating rst files from stories and linter sources was part of
docs/conf.py. Hopefully, there will be more generated rst sources from tmt code, therefore doing a small cleanup:docs/MakefileandMakefilehave been modified to offer nice help and use the new scripts for generating stuff, in a more make-like fashion, instead of lettingconf.pycontrol their creation.Pull Request Checklist