rwx.work/help
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

sphinx

Browse source
This commit is contained in:
Marc Beninca 2019-08-25 12:18:42 +02:00
parent b88b8cff79
commit 9466cf6723
7 changed files with 16 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

4
in/public/sphinx/build.rst Normal file
View file

@ -0,0 +1,4 @@
Build documentation
===================
.. todo:: command line and conf.py

13
in/public/sphinx/configure.rst Normal file
View file

@ -0,0 +1,13 @@
***********************
Configure documentation
***********************
MarkDown
========
.. code:: python3
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
source_suffix = ['.rst', '.md']

3
in/public/sphinx/create.rst Normal file
View file

@ -0,0 +1,3 @@
********************
Create documentation
********************

9
in/public/sphinx/index.rst Normal file
View file

@ -0,0 +1,9 @@
sphinx
======
.. toctree::
install
configure
create
build

13
in/public/sphinx/install.rst Normal file
View file

@ -0,0 +1,13 @@
Install
=======
.. code:: shell
apt install python3-sphinx
apt install python3-sphinx-rtd-theme
* if markdown documents
.. code:: shell
apt install python3-recommonmark