-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add new CLI tool to allow custom html/pdf docs generation #22
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
Basic description on how it should be used. Signed-off-by: Jorge Marques <[email protected]>
Allows to aggregate custom documents with filtered content using human friendly YAML files. Use cases: * Tutorials * User guides * Driver guides Signed-off-by: Jorge Marques <[email protected]>
Build custom doc from the template yaml. Signed-off-by: Jorge Marques <[email protected]>
Good side-effect: will also trigger a full rebuild. Signed-off-by: Jorge Marques <[email protected]>
V0 -> V1 Custom-doc
Author-mode
General
|
For LaTeX to SVG conversion. Signed-off-by: Jorge Marques <[email protected]>
Signed-off-by: Jorge Marques <[email protected]>
Revert media_print for hdl directives. The reason is that improvements to the CSS fixes the original need to have a different output for PDFs. The media_print variable should be used in scenarios where it is explicitly needed to compile the content in a different manner than for the hosted html. For example, to render some content that would instead be rendered with JavaScript libraries in the user browser. Signed-off-by: Jorge Marques <[email protected]>
Describe the inner workings. Add how to use WeasyPrint and why. Signed-off-by: Jorge Marques <[email protected]>
V1->V2
Remaining caution:
Missing nice to have:
|
Uses subprocess because creating a new Sphinx class: * Do not re-eval the roles/directives, but * Trigger a full rebuild due to env changes so it is no use for developing purposes. Maybe importlib.reload() + monkey patch could be an alternative, but not triggering full env reload would be tricky, so this is good enough. Signed-off-by: Jorge Marques <[email protected]>
The Grid and Flex directives allow to dispose content in a tabular manner. They resolve into CSS grid and flex elements, the prior with an explicit number of columns Signed-off-by: Jorge Marques <[email protected]>
Signed-off-by: Jorge Marques <[email protected]>
Add support to cd command with quotes, e.g. $cd '/to/some path' Most useful for ps1/windows paths. Signed-off-by: Jorge Marques <[email protected]>
Re-enable when a better approach is figured out. Signed-off-by: Jorge Marques <[email protected]>
Used sass-migrator module --migrate-deps bundle.scss following deprecation notice Signed-off-by: Jorge Marques <[email protected]>
Signed-off-by: Jorge Marques <[email protected]>
Signed-off-by: Jorge Marques <[email protected]>
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.
Uses human friendly YAML files, e.g.:
Missing features:
Empty sections remover
After filtering the toctrees, some sections used to add captions to toctrees (e.g. ADCs, Obsolte IPs, etc) are left empty. those could be removed.
Missing caution:
Figure out exactly if the tool works with all Sphinx version supported. (Fixed v1)
In particular, it relies on parsing error with the suffix
[some.thing]
e.g.[ref.ref]
and I remember not seeing it on every sphinx output. Is this configurable or something added later/before? (Fixed v1)Not passing media_print (Fixed v1)
Check if grabbed extensions are installed on the system before calling sphinx, to gracefully fail (Fixed v1)
If a subprocess fail (eg. git clone with no internet/ssh key) gracefully return instead of keep going (Fixed v1)