Commits

Benjamin Althues  committed 3a6c9bd

Do not use sphinx for generating user docs anymore

Create only the developer documentation with Sphinx. The developer
documentation is now in the README and the website.

  • Participants
  • Parent commits b025adc

Comments (0)

Files changed (9)

 	find . -name "*.pyc" | xargs /bin/rm -f
 
 doc_clean: rm_pyc
-	cd sphinx-doc/root/; make clean
 	cd sphinx-doc/en/; make clean
 	#cd sphinx-doc/nl/; make clean
 
 doc: doc_clean
-	cd sphinx-doc/root/; make html
 	cd sphinx-doc/en/; make html
-	#cd sphinx-doc/nl/; make html
-	rm -rf doc/html
-	mkdir -p doc
-	mv sphinx-doc/root/_build/html doc/html
+	cd sphinx-doc/nl/; make html
+	rm -rf doc/html/$(VERSION)
 	mkdir -p doc/html/$(VERSION)
 	mv sphinx-doc/en/_build/html doc/html/$(VERSION)/en
-	mv doc/html/index.html doc/html/all.html
-	#mv sphinx-doc/nl/_build/html doc/html/$(VERSION)/nl
+	mv sphinx-doc/nl/_build/html doc/html/$(VERSION)/nl
 	make doc_clean
 
 man: rm_pyc

File sphinx-doc/en/devdoc.rst

-Developer documentation
-******************************************************************************
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
-dispass.algos
-==============================================================================
-
-.. automodule:: dispass.algos
-   :members:
-
-dispass.dispass
-==============================================================================
-
-.. automodule:: dispass.dispass
-   :members:
-
-dispass.cli
-==============================================================================
-
-.. automodule:: dispass.cli
-   :members:
-
-dispass.gui
-==============================================================================
-
-.. automodule:: dispass.gui
-   :members:
-
-dispass.filehandler
-==============================================================================
-
-.. automodule:: dispass.filehandler
-   :members:
-
-dispass.interactive_editor
-==============================================================================
-
-.. automodule:: dispass.interactive_editor
-   :members:
-
-
-.. vim: set et ts=3 sw=3 sts=3 ai:

File sphinx-doc/en/index.rst

-Show all versions_ | Language: **English**
+Developer documentation
+******************************************************************************
 
-.. _`versions`: ../../all.html
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
 
-.. include:: ../../README.rst
+dispass.algos
+==============================================================================
 
-.. toctree::
-   :maxdepth: 2
+.. automodule:: dispass.algos
+   :members:
+
+dispass.dispass
+==============================================================================
+
+.. automodule:: dispass.dispass
+   :members:
+
+dispass.cli
+==============================================================================
+
+.. automodule:: dispass.cli
+   :members:
+
+dispass.gui
+==============================================================================
+
+.. automodule:: dispass.gui
+   :members:
+
+dispass.filehandler
+==============================================================================
+
+.. automodule:: dispass.filehandler
+   :members:
+
+dispass.interactive_editor
+==============================================================================
+
+.. automodule:: dispass.interactive_editor
+   :members:
 
-   devdoc
 
 .. vim: set et ts=3 sw=3 sts=3 ai:

File sphinx-doc/nl/devdoc.rst

-.. note::
-   Dit gedeelte is om praktische redenen alleen beschikbaar in het Engels.
-
-Documentatie voor ontwikkelaars
-******************************************************************************
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
-dispass.algos
-==============================================================================
-
-.. automodule:: dispass.algos
-   :members:
-
-dispass.dispass
-==============================================================================
-
-.. automodule:: dispass.dispass
-   :members:
-
-dispass.cli
-==============================================================================
-
-.. automodule:: dispass.cli
-   :members:
-
-dispass.gui
-==============================================================================
-
-.. automodule:: dispass.gui
-   :members:
-
-dispass.filehandler
-==============================================================================
-
-.. automodule:: dispass.filehandler
-   :members:
-
-dispass.interactive_editor
-==============================================================================
-
-.. automodule:: dispass.interactive_editor
-   :members:
-
-
-.. vim: set et ts=3 sw=3 sts=3 ai:

File sphinx-doc/nl/index.rst

 .. note::
-   No dutch documentation available yet
+   Dit gedeelte is om praktische redenen alleen beschikbaar in het Engels.
 
-.. include:: ../../README.rst
+Documentatie voor ontwikkelaars
+******************************************************************************
 
-.. toctree::
-   :maxdepth: 2
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+dispass.algos
+==============================================================================
+
+.. automodule:: dispass.algos
+   :members:
+
+dispass.dispass
+==============================================================================
+
+.. automodule:: dispass.dispass
+   :members:
+
+dispass.cli
+==============================================================================
+
+.. automodule:: dispass.cli
+   :members:
+
+dispass.gui
+==============================================================================
+
+.. automodule:: dispass.gui
+   :members:
+
+dispass.filehandler
+==============================================================================
+
+.. automodule:: dispass.filehandler
+   :members:
+
+dispass.interactive_editor
+==============================================================================
+
+.. automodule:: dispass.interactive_editor
+   :members:
 
-   devdoc
 
 .. vim: set et ts=3 sw=3 sts=3 ai:

File sphinx-doc/root/Makefile

-../en/Makefile

File sphinx-doc/root/conf.py

-../en/conf.py

File sphinx-doc/root/doclanguage.py

-../en/doclanguage.py

File sphinx-doc/root/index.rst

-DisPass
-******************************************************************************
-
-`Click here for the latest stable release`__
-
-Releases
-==============================================================================
-
-`DisPass 0.1-alpha-8`_ - released June 21st, 2012
-
-`DisPass 0.1-alpha-7`_ - released May 28th, 2012
-
-`DisPass 0.1-alpha-6`_ - released May 24th, 2012
-
-.. _`DisPass 0.1-alpha-6`: 0.1a6/en/index.html
-.. _`DisPass 0.1-alpha-7`: 0.1a7/en/index.html
-.. _`DisPass 0.1-alpha-8`: 0.1a8/en/index.html
-
-__ `DisPass 0.1-alpha-8`_
-
-.. include:: ../../ChangeLog.rst
-
-.. vim: set et ts=3 sw=3 sts=3 ai: