User Tools

Site Tools


configuration:sphinx

Sphinx - TutorialGenerator

Installation Sphinx

  • 'pip install -U sphinx' in der Administrator-Console

Konfiguration Sphinx

  • Arbeitsverzeichnis erzeugen und dorthin wechseln: c:/Downloads/sphinx
  • sphinx-quickstart ausführen

Theme-Wechsel

  • auf Github o.ä. passendes Theme finden: 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

source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'markdown',
    '.md': 'markdown',
}
#
extensions = ["myst_parser"]
  • Markdown-Page helper.md:
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>
  • 'pip install nbsphinx'
  • 'pip install sphinx-math-dollar'
  • in 'conf.py' ändern:
    • 'mathjax_config = {' zu
    • 'mathjax3_config = {'

ToDo / Done

220918

  • Zweiteinrichtung des TutorialGenerators: Sphinx

Open Hard- & Software [ DokuWiki WebSites MediaWiki NextCloud ]

configuration/sphinx.txt · Last modified: 2022/09/18 22:33 by omdevelop