chore(docs): document HTML custom templates #357
Conversation
Shows an example of custom template. TODO: - [ ] finish documentating; - [ ] add possibility to pass `-cargs` to Manim Slides' `convert` method when calling the Sphinx extension. Closes #356
jeertmans
had a problem deploying
to
github-pages
GitHub Actions
Error
for more information, see https://pre-commit.ci
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ### What to add | ||
|
|
||
| ```{eval-rst} |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
Two consecutive dots (DOUBLE_PUNCTUATION)
Suggestions: ., …
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-periods
Rule: https://community.languagetool.org/rule/show/DOUBLE_PUNCTUATION?lang=en-US
Category: PUNCTUATION
|
|
||
| ```{eval-rst} | ||
| .. literalinclude:: ../_static/template.diff | ||
| :language: html |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
Suggestions: HTML
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
Category: CASING
|
|
||
| ### Full code | ||
|
|
||
| ```{eval-rst} |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
Two consecutive dots (DOUBLE_PUNCTUATION)
Suggestions: ., …
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-periods
Rule: https://community.languagetool.org/rule/show/DOUBLE_PUNCTUATION?lang=en-US
Category: PUNCTUATION
|
|
||
| ```{eval-rst} | ||
| .. literalinclude:: ../_static/template.html | ||
| :language: html+jinja |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
Suggestions: HTML
URL: https://languagetool.org/insights/post/spelling-capital-letters/
Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
Category: CASING
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #357 +/- ##
==========================================
- Coverage 80.60% 80.33% -0.27%
==========================================
Files 21 21
Lines 1789 1795 +6
==========================================
Hits 1442 1442
- Misses 347 353 +6 ☔ View full report in Codecov by Sentry. |
jeertmans
temporarily deployed
to
github-pages
GitHub Actions
Inactive
| Then, using the `:template: <path/to/custom_template.html>` | ||
| option, the basic example renders as follows: | ||
|
|
||
| ```{eval-rst} |
There was a problem hiding this comment.
[LanguageTool] reported by reviewdog 🐶
Two consecutive dots (DOUBLE_PUNCTUATION)
Suggestions: ., …
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-periods
Rule: https://community.languagetool.org/rule/show/DOUBLE_PUNCTUATION?lang=en-US
Category: PUNCTUATION
Shows an example of custom template.
TODO:
-cargsto Manim Slides'convertmethod when calling the Sphinx extension.Closes #356