Updated sphinx documentation

docs/Makefile

@@ -50,7 +50,6 @@ clean:
 	rm -rf $(BUILDDIR)/*
 
 html:
-	sphinx-apidoc -f -o . ../hdlmake
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

docs/action.rst

+action package
+==============
+
+Submodules
+----------
+
+action.action module
+--------------------
+
+.. automodule:: action.action
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.check_condition module
+-----------------------------
+
+.. automodule:: action.check_condition
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.check_manifest module
+----------------------------
+
+.. automodule:: action.check_manifest
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.clean module
+-------------------
+
+.. automodule:: action.clean
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.fetch module
+-------------------
+
+.. automodule:: action.fetch
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.fetch_makefile module
+----------------------------
+
+.. automodule:: action.fetch_makefile
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.list_files module
+------------------------
+
+.. automodule:: action.list_files
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.list_modules module
+--------------------------
+
+.. automodule:: action.list_modules
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.merge_cores module
+-------------------------
+
+.. automodule:: action.merge_cores
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.remote_synthesis module
+------------------------------
+
+.. automodule:: action.remote_synthesis
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.simulation module
+------------------------
+
+.. automodule:: action.simulation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.synthesis module
+-----------------------
+
+.. automodule:: action.synthesis
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+action.synthesis_project module
+-------------------------------
+
+.. automodule:: action.synthesis_project
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: action
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/conf.py

@@ -192,6 +192,11 @@ latex_elements = {
 
 # Additional stuff for the LaTeX preamble.
 #'preamble': '',
+
+  # Remove blank pages
+  'classoptions': ',openany,oneside',
+  'babel': '\\usepackage[english]{babel}'
+
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -204,7 +209,7 @@ latex_documents = [
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+latex_logo = 'images/ohr_logo.png'
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.

docs/dep_file.rst

+dep_file module
+===============
+
+.. automodule:: dep_file
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/dep_solver.rst

+dep_solver module
+=================
+
+.. automodule:: dep_solver
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/dependable_file.rst

+dependable_file module
+======================
+
+.. automodule:: dependable_file
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/env.rst

+env module
+==========
+
+.. automodule:: env
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/fetch.rst

+fetch package
+=============
+
+Submodules
+----------
+
+fetch.backend_factory module
+----------------------------
+
+.. automodule:: fetch.backend_factory
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fetch.fetcher module
+--------------------
+
+.. automodule:: fetch.fetcher
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fetch.git module
+----------------
+
+.. automodule:: fetch.git
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fetch.svn module
+----------------
+
+.. automodule:: fetch.svn
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: fetch
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/global_mod.rst

+global_mod module
+=================
+
+.. automodule:: global_mod
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/makefile_writer.rst

+makefile_writer module
+======================
+
+.. automodule:: makefile_writer
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/manifest_parser.rst

+manifest_parser module
+======================
+
+.. automodule:: manifest_parser
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/module.rst

+module module
+=============
+
+.. automodule:: module
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/module_pool.rst

+module_pool module
+==================
+
+.. automodule:: module_pool
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules.rst

+hdlmake
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   action
+   dep_file
+   dep_solver
+   dependable_file
+   env
+   fetch
+   global_mod
+   makefile_writer
+   manifest_parser
+   module
+   module_pool
+   new_dep_solver
+   srcfile
+   tools
+   util
+   vhdl_parser
+   vlog_parser

docs/new_dep_solver.rst

+new_dep_solver module
+=====================
+
+.. automodule:: new_dep_solver
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/srcfile.rst

+srcfile module
+==============
+
+.. automodule:: srcfile
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/tools.aldec.rst

+tools.aldec package
+===================
+
+Submodules
+----------
+
+tools.aldec.aldec module
+------------------------
+
+.. automodule:: tools.aldec.aldec
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: tools.aldec
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/tools.diamond.rst

+tools.diamond package
+=====================
+
+Submodules
+----------
+
+tools.diamond.diamond module
+----------------------------
+
+.. automodule:: tools.diamond.diamond
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: tools.diamond
+    :members:
+    :undoc-members:
+    :show-inheritance: