You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: en/documentation_howto.rst
+22-27Lines changed: 22 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ You find the Mapbender Documentation at:
10
10
11
11
https://doc.mapbender.org
12
12
13
-
The Documentation is build from the mapbender-docmentation repository at Github. This repository is used to build and deploy the http://doc.mapbender.org website on a nightly base. The website code is generated using Sphinx, therefore the documentation source is written in Restructured Text.
13
+
The Documentation is build from the mapbender-docmentation repository at Github. This repository is used to build and deploy the https://doc.mapbender.org website. The website code is generated using Sphinx, therefore the documentation source is written in Restructured Text.
14
14
15
15
This HowTo concentrates on the build of the documentation at http://doc.mapbender.org.
16
16
@@ -47,25 +47,13 @@ Every language (en - english, de - german) has the same file structure.
47
47
index.rst # refers to TheBook, Developer's Book & the Bundle Documentation
48
48
bundles.rst # lists the chapters of this category - refers to rst files
49
49
development.rst # lists the chapters of this category - refers to rst files
50
-
thebook.rst # lists the chapters of this category - refers to rst files
51
-
/book
52
-
....
53
-
/development
50
+
/architecture
51
+
/development
52
+
....
53
+
/functions
54
+
/backend
55
+
/basic
54
56
....
55
-
/bundles
56
-
/Mapbender
57
-
/CoreBundle
58
-
index.rst # refers to the elements, entitiy & service documentation
59
-
template_element.rst # template to use for new element documentation
60
-
/elements
61
-
legend.rst
62
-
...
63
-
/services
64
-
...
65
-
/WmsBundle
66
-
...
67
-
/FOM
68
-
...
69
57
70
58
71
59
How to build the documentation via Sphinx?
@@ -77,14 +65,17 @@ To build the website locally, you need to install Sphinx. In Debian-based distri
77
65
78
66
.. code-block:: bash
79
67
80
-
apt-get install python-sphinx
68
+
sudo apt-get install sphinx-common python3-sphinx
69
+
sudo apt-get install pip3
70
+
sudo pip3 install sphinxcontrib-phpdomain
81
71
82
72
83
73
You can then build the documentation by running
84
74
85
75
.. code-block:: bash
86
76
87
-
sphinx-build . output
77
+
sphinx-build . _build -A version=3.2.0
78
+
88
79
89
80
You can also use the generate.sh shell script if you like.
90
81
@@ -157,7 +148,7 @@ Here are the steps you have to do:
0 commit comments