User Tools

Site Tools


configuration:sphinx

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
configuration:sphinx [2022/09/18 15:51] – [Installation Sphinx] omdevelopconfiguration:sphinx [2022/09/18 22:33] (current) – [Integration von Markdown-Files] omdevelop
Line 18: Line 18:
  
 ===== Theme-Wechsel ===== ===== Theme-Wechsel =====
-  * auf Github o.ä. passendes Theme finden +  * auf Github o.ä. passendes Theme finden: [[https://github.com/readthedocs/sphinx_rtd_theme | sphinx_rtd_theme]] 
-  * **'pip install sphinx-rtd-theme'**+  * In Admin-Console Theme installieren: **'pip install sphinx-rtd-theme'** 
 +  * ändern der Sphinx-Konfigurationsdatei **conf.py** auf **html_theme = "sphinx_rtd_theme"** 
 +  * wichtig: KEINE Hochkommas, sondern Gänsefüsse!!!
  
 +===== Integration von Markdown-Files =====
 +  * **'pip install --upgrade myst-parser'** {{https://www.sphinx-doc.org/en/master/usage/markdown.html | Sphinx-Markdown}}
 +
 +<code>
 +source_suffix = {
 +    '.rst': 'restructuredtext',
 +    '.txt': 'markdown',
 +    '.md': 'markdown',
 +}
 +#
 +extensions = ["myst_parser"]
 +</code>
 +
 +  * Markdown-Page **helper.md**:
 +
 +<code>
 +Helper
 +======
 +# Main
 +## Sub
 +### SubSub
 +#### SubSubSub
 +##### SubSubSubSub
 +###### SubSubSubSubSub
 +<h1>asdfsd</h1>
 +<h2>asdfsd</h2>
 +<h3>asdfsd</h3>
 +<h4>asdfsd</h4>
 +<h5>asdfsd</h5>
 +<h6>asdfsd</h6>
 +</code>
 +
 +  * **'pip install nbsphinx'**
 +  * **'pip install sphinx-math-dollar'**
 +  * in 'conf.py' ändern:
 +    * **'mathjax_config = {'** zu
 +    * **'mathjax3_config = {'**
 +
 + 
 ===== ToDo / Done ===== ===== ToDo / Done =====
  
configuration/sphinx.1663509081.txt.gz · Last modified: 2022/09/18 15:51 by omdevelop