GitHub - cde-ev/DokuForge2

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 1,923 Commits
dokuforge		dokuforge
testData		testData
.drone.yml		.drone.yml
Announce.txt		Announce.txt
COPYING		COPYING
MANIFEST.in		MANIFEST.in
Makefile		Makefile
README		README
README-rlog.txt		README-rlog.txt
branch-notes.sh		branch-notes.sh
createexample.py		createexample.py
dokuforge.conf.sample		dokuforge.conf.sample
epydoc.conf		epydoc.conf
localExport.sh		localExport.sh
parserexample.py		parserexample.py
requirements.txt		requirements.txt
setup.py		setup.py
test.py		test.py

Repository files navigation

Prerequisites:
~~~~~~~~~~~~~~

Dokuforge has the following dependencies:
 * Python (version >= 3.6)
 * rcs
   Required: yes
   Homepage: http://www.cs.purdue.edu/homes/trinkle/RCS/
   Debian: rcs
   FreeBSD: included in base system
   Gentoo: dev-vcs/rcs
 * mathjax
   Required: only for rendering math
   Homepage: http://www.mathjax.org/
   Debian: libjs-mathjax
   FreeBSD: suggested (PR ports/153195)
   Gentoo: not packaged
   Download: http://github.com/mathjax/MathJax/zipball/v1.1a

Additionally, the following python packages are required. The minimal version can be
taken from the `requirements.txt` file:
 * werkzeug
   Required: yes
   Homepage: http://werkzeug.pocoo.org/
   Debian: python-werkzeug
   FreeBSD: www/py-werkzeug
   Gentoo: dev-python/werkzeug
 * jinja (version 2.x)
   Required: yes
   Homepage: http://jinja.pocoo.org/
   Debian: python-jinja2
   FreeBSD: devel/py-Jinja2
   Gentoo: dev-python/jinja
 * webtest
   Required: only for the test suite
   Homepage: http://webtest.pythonpaste.org
   Debian: python-webtest
   FreeBSD: www/py-WebTest
   Gentoo: dev-python/webtest
 * wsgitools
   Required: for using serve_* except serve_debug
   Homepage: http://www.subdivi.de/~helmut/wsgitools/
   Debian: not packaged
   FreeBSD: devel/py-wsgitools
   Gentoo: not packaged
   Download: http://www.subdivi.de/~helmut/darcs/wsgitools/dist/wsgitools-0.2.2.tar.gz
 * epydoc
   Required:
   Homepage: http://epydoc.sourceforge.net/
   Debian: python-epydoc
   FreeBSD: devel/epydoc
   Gentoo: dev-python/epydoc

 Short forms:
  * Debian: aptitude install python-werkzeug python-jinja2 rcs python-webtest python-epydoc libjs-mathjax
  * FreeBSD: ... www/py-werkzeug devel/py-Jinja2 www/py-WebTest devel/epydoc devel/py-wsgitools
  * Gentoo: emerge dev-python/werkzeug dev-python/jinja dev-vcs/rcs dev-python/webtest dev-python/epydoc

Configuration:
~~~~~~~~~~~~~~
Copy dokuforge.conf.sample and update it. A basic data set for testing can be
created by invoking python createexample.py.

Running:
~~~~~~~~
The simplest form is
python -m dokuforge.serve_simple path_to_your_dokuforge.conf
It will start a webserver on localhost:8800.