Skip to content

Commit 28df011

Browse files
committed
Added infos to Readme, Howto doku
1 parent 4143d2f commit 28df011

2 files changed

Lines changed: 24 additions & 30 deletions

File tree

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,10 @@ Example
3030
```bash
3131

3232
cd /data
33-
git clone https://github.com/mapbender/mapbender-documentation.git
34-
cd mapbender-documentation
33+
git clone git clone git@github.com:mapbender/mapbender-documentation
3534
git checkout release/3.2.0
3635

37-
ln -s /data/mapbender-documentation/_build/ mb-doc
36+
ln -s /data/mapbender-documentation/_build/ /var/www/html/mb-doc
3837

3938
rm -Rf _build
4039
sphinx-build . _build -A version=3.2.0

en/documentation_howto.rst

Lines changed: 22 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You find the Mapbender Documentation at:
1010

1111
https://doc.mapbender.org
1212

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.
1414

1515
This HowTo concentrates on the build of the documentation at http://doc.mapbender.org.
1616

@@ -47,25 +47,13 @@ Every language (en - english, de - german) has the same file structure.
4747
index.rst # refers to TheBook, Developer's Book & the Bundle Documentation
4848
bundles.rst # lists the chapters of this category - refers to rst files
4949
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
5456
....
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-
...
6957
7058
7159
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
7765

7866
.. code-block:: bash
7967
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
8171
8272
8373
You can then build the documentation by running
8474

8575
.. code-block:: bash
8676
87-
sphinx-build . output
77+
sphinx-build . _build -A version=3.2.0
78+
8879
8980
You can also use the generate.sh shell script if you like.
9081

@@ -157,7 +148,7 @@ Here are the steps you have to do:
157148
# get the documentation files from github
158149
cd /data
159150
git clone git@github.com:mapbender/mapbender-documentation
160-
cd /mapbender-documentation/en/bundles/Mapbender/CoreBundle
151+
cd /mapbender-documentation/en/functions/basic
161152
162153
# create a rst-file. Use the template for element documentation!
163154
cp template_element.rst elements/add_wms.rst
@@ -166,18 +157,22 @@ Here are the steps you have to do:
166157
167158
# build the the documentation locally to see how your documentation looks like
168159
cd /data/mapbender-documentation/
169-
sphinx-build . output
160+
rm -Rf _build
161+
sphinx-build . _build -A version=3.2.0
170162
171163
# have a look at the documentation in your browser (example location). Is everything ok? Any changes needed?
172-
file:///data/mapbender-documentation/output/index.html
164+
ln -s /data/mapbender-documentation/_build/ /var/www/html/mb-doc
165+
http://localhost/mb-doc/
173166
174167
# add, commit and push your new file to the mapbender-documentation repository
175168
# replace <element_name> with the element name, dont forget to remove the <, >
176-
git add en/bundles/Mapbender/CoreBundle/elements/<element_name>.rst
177-
git commit -m 'new documentation for element <element_name>' en/bundles/Mapbender/CoreBundle/elements/<element_name>.rst
178-
git push
169+
git checkout -b feature/add_wms
170+
git add en/functions/basic/add_wms.rst
171+
git commit -m 'new documentation for element <element_name>'
172+
git push --set-upstream origin feature/add_wms
179173
180174
# get the actual files from the mapbender-documentation repository
175+
git checkout master
181176
git pull
182177
183178

0 commit comments

Comments
 (0)