Docs: Add a book preprocessor #910
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
|
Submitted an issue to mdbook: rust-lang/mdBook#2289 |
|
mdbook issue was closed in favor of rust-lang/mdBook#1424 which is open and not touches for 3 years now, so we shouldn't hope for mdbook fix. Imo the script I wrote should be enough, if it isn't I can write more complicated one that would always work. |
piodul
reviewed
Jan 12, 2024
| @@ -0,0 +1,34 @@ | |||
| import json | |||
There was a problem hiding this comment.
Nit: how about adding a shebang? We had it in the previous script.
There was a problem hiding this comment.
This script is not supposed to be run manually, so I don't see how shebang helps?
This is to avoid having to use build_book.py script. 1. Preprocessor is faster and doesn't use disk, as all communication is trough stdio. 2. It doesn't need to be executed explicitly. You can just use `mdbook build docs` and it will create correct documentation. 3. New script is shorter and simpler than old. Script is based on example from https://rust-lang.github.io/mdBook/for_developers/preprocessors.html and uses a function from build_book.py In book.toml the command used is a simple bash script instead of just `python ./sphinx_preprocessor.py` because the command is run in the directory the user executed it in, not the directory that book.toml is in (which is imho a poor design in this case), so in order to be able to run the command both from main dir and from docs dir, such a script locating the preprocessor is necessary.
This script is no longer necessary and just double the work
Lorak-mmk
force-pushed
the
book-preprocessor
branch
from
0b14a4f
to
9b8ef00
Compare
|
v2
|
piodul
approved these changes
Jan 12, 2024
Closed
8 tasks
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 PR adds a preprocessor for the book that removes Sphinx-related sections.
This was previously done by
docs/build_book.pyscript, which this PR removes.There are some advantages of new approach:
There is one disadvantage: book must be built either from main directory, or docs directory. If it's built from different location, build will succeed buy Sphinx sections won't be stripped.
This is because of mdbook limitation - PWD of build process is the folder the command is executed in, not the folder in which book.toml is located.
This shouldn't be a problem - I suspect book build is never / very rarely executed from other dir.
If it becomes a problem, it's possible to fix it. The script in bash.sh will need to be modified:
supportsargument - just exit.rootelement,cdto it's value.python ./sphinx_preprocessor.pywith previosuly-read stdin.Pre-review checklist
./docs/source/.Fixes:annotations to PR description.