mirror of
https://github.com/Combodo/iTop.git
synced 2026-04-23 02:28:44 +02:00
Moved from recommonmark to MyST
This commit is contained in:
@@ -15,7 +15,7 @@ Under `.doc/UI`, run
|
||||
```
|
||||
pip install -U sphinx
|
||||
pip install sphinx-rtd-theme
|
||||
pip install recommonmark
|
||||
pip install myst-parser
|
||||
pip install sphinx-multiversion
|
||||
```
|
||||
|
||||
@@ -28,10 +28,18 @@ Under `.doc/UI`, run
|
||||
```
|
||||
sudo apt-get install python3-sphinx
|
||||
pip install sphinx-rtd-theme
|
||||
pip install recommonmark
|
||||
pip install myst-parser
|
||||
pip install sphinx-multiversion
|
||||
```
|
||||
|
||||
## Documentations
|
||||
|
||||
* sphinx https://www.sphinx-doc.org/en/master/
|
||||
* sphinx-multiversion https://holzhaus.github.io/sphinx-multiversion/master/index.html
|
||||
* Read the Docs https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
|
||||
* RST https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
|
||||
* MyST https://myst-parser.readthedocs.io/en/latest/
|
||||
|
||||
## Generating the documentation
|
||||
|
||||
### Generating the documentation source from the actual code
|
||||
|
||||
@@ -30,7 +30,7 @@ release = 'iTop 3.1.0'
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = ['sphinx.ext.autosectionlabel', 'recommonmark', 'sphinx_multiversion']
|
||||
extensions = ['sphinx.ext.autosectionlabel', 'myst_parser', 'sphinx_multiversion']
|
||||
|
||||
autosectionlabel_prefix_document = True
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: b777371d0cb7f82f1ee933dcfdfd2818
|
||||
config: e3a40548087e815ba9878ab96a079a32
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Reference in New Issue
Block a user