sphinx blockdiag

jpeg-dev zlib-dev
sphinx restbuilder
wrong path to html folder
home.html -> index.html
adding some more docs
module autodoc
title
build directly in folder public
add path to doc
no file ending in toctree

.gitlab-ci.yml

@@ -2,11 +2,10 @@ image: alpine
 
 pages:
   script:
-  - apk --no-cache add py2-pip python-dev
-  - pip install sphinx
+  - apk --no-cache add py2-pip python-dev build-base jpeg-dev zlib-dev
+  - pip install sphinx sphinxcontrib-blockdiag blockdiag sphinxcontrib-restbuilder
   - apk --no-cache add make
   - make html
-  - mv _build/html/ public/
   artifacts:
     paths:
     - public

Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = build
+BUILDDIR      = public
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
@@ -50,7 +50,7 @@ clean:
 
 .PHONY: html
 html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 

doc/conf.py

@@ -17,9 +17,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../'))
 
 # -- General configuration ------------------------------------------------
 
@@ -55,11 +55,11 @@ source_suffix = '.rst'
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'home'
+master_doc = 'index'
 
 # General information about the project.
 project = 'ESS Python Tools'
-copyright = '2016, Ryoichi Miyamoto, Yngve Levinsen'
+copyright = '2016-18, Ryoichi Miyamoto, Yngve Levinsen'
 author = 'Ryoichi Miyamoto, Yngve Levinsen'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -129,7 +129,8 @@ todo_include_todos = True
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+#html_theme = 'alabaster'
+html_theme = 'sphinxdoc'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

doc/ess/TraceWin.rst

+ess.TraceWin
+----------------
+
+Main description of this module is not written yet
+
+.. automodule:: ess.TraceWin
+    :members:

doc/ess/index.rst

+API Reference
+*************
+
+Two main libraries
+
+* :class:`ess.lib_tw` TraceWin library originally from Ryoichi
+
+* :class:`ess.TraceWin` TraceWin library originally from Yngve
+
+
+
+.. toctree::
+   :maxdepth: 2
+
+   TraceWin
+   lib_tw

doc/ess/lib_tw.rst

+ess.lib_tw
+----------------
+
+Main description of this module is not written yet
+
+.. automodule:: ess.lib_tw
+    :members:

doc/home.rst → doc/index.rst

@@ -11,7 +11,9 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
-
+    other
+    ess/index
+    scripts/index
 
 Indices and tables
 ==================
@@ -20,4 +22,4 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-
+Documentation last updated: |today|

doc/other.rst

+Test Doc
+--------

doc/scripts/index.rst

+ESS Scripts
+-----------
+
+No documentation provided yet