← Back to branch summary

~widelands-dev/widelands-website/django_staticfiles

« back to all changes in this revision

Viewing changes to README.txt

removed unmaintained sphinx-doc; added managemnt command to create sphinx source code documentation with some own css; serve pure html for documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.txt
150
150
Setting up widelands source code documentation
151
151
----------------------------------------------
152
152
 
153
 
Change to the directory doc/sphinx/ of the widelands source code and run
154
 
 
155
 
   $ ./extract_rst.py
156
 
 
157
 
Now create the documentation as json files. You have to provide the path to
158
 
the sphinx-build executable of the website:
159
 
 
160
 
   $ ~/wlwebsite/bin/sphinx-build -b json -d build/doctrees source build/json
161
 
 
162
 
A new directory containing json files is created in doc/sphinx/build/json. The full path
163
 
to this directory has to be set in the sphinxdoc-app of the website:
164
 
 
165
 
Open http://localhost:8000/admin/sphinxdoc/app/ and add a new app with this values:
166
 
 
167
 
Name: Widelands developer documentation
168
 
Slug: wl
169
 
Path: /your/path/to/widelands-src/doc/sphinx/build/json/
170
 
 
171
 
Open http://localhost:8000/docs/wl/ to test if everything is working.
 
153
There is a small helper script to get the documenation. Be sure
 
154
you have set WIDELANDS_SVN_DIR set in local_settings.py. Run:
 
155
 
 
156
   $ ./manage.py create_docs
 
157
 
 
158
After finishing without errors, type localhost:8000/documentation/index.html
 
159
in your browsers addressbar or click on "Development -> Documentation".
 
160
 
172
161
 
173
162
Uploading a map to the local website
174
163
------------------------------------
182
171
Contact
183
172
=======
184
173
 
185
 
Contact SirVer on the homepage for more information and problems.
 
174
Contact user 'kaputtnik' on the homepage for more information and problems.
186
175
 
187
176
 
188
177
-- vim:ft=rst: