Updated sphinx documentation & API

parent e01cc160
......@@ -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."
......
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:
dep_file module
===============
.. automodule:: dep_file
:members:
:undoc-members:
:show-inheritance:
dep_solver module
=================
.. automodule:: dep_solver
:members:
:undoc-members:
:show-inheritance:
dependable_file module
======================
.. automodule:: dependable_file
:members:
:undoc-members:
:show-inheritance:
env module
==========
.. automodule:: env
:members:
:undoc-members:
:show-inheritance:
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:
global_mod module
=================
.. automodule:: global_mod
:members:
:undoc-members:
:show-inheritance:
This diff is collapsed.
makefile_writer module
======================
.. automodule:: makefile_writer
:members:
:undoc-members:
:show-inheritance:
manifest_parser module
======================
.. automodule:: manifest_parser
:members:
:undoc-members:
:show-inheritance:
module module
=============
.. automodule:: module
:members:
:undoc-members:
:show-inheritance:
module_pool module
==================
.. automodule:: module_pool
:members:
:undoc-members:
:show-inheritance:
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
new_dep_solver module
=====================
.. automodule:: new_dep_solver
:members:
:undoc-members:
:show-inheritance:
srcfile module
==============
.. automodule:: srcfile
:members:
:undoc-members:
:show-inheritance:
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:
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:
tools.ghdl package
==================
Submodules
----------
tools.ghdl.ghdl module
----------------------
.. automodule:: tools.ghdl.ghdl
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: tools.ghdl
:members:
:undoc-members:
:show-inheritance:
tools.ise package
=================
Submodules
----------
tools.ise.ise module
--------------------
.. automodule:: tools.ise.ise
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: tools.ise
:members:
:undoc-members:
:show-inheritance:
tools.isim package
==================
Submodules
----------
tools.isim.isim module
----------------------
.. automodule:: tools.isim.isim
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: tools.isim
:members:
:undoc-members:
:show-inheritance:
tools.iverilog package
======================
Submodules
----------
tools.iverilog.iverilog module
------------------------------
.. automodule:: tools.iverilog.iverilog
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: tools.iverilog
:members:
:undoc-members:
:show-inheritance:
tools.libero package
====================
Submodules
----------
tools.libero.libero module
--------------------------
.. automodule:: tools.libero.libero
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: tools.libero
:members:
:undoc-members:
:show-inheritance:
tools.modelsim package
======================
Submodules
----------
tools.modelsim.modelsim module
------------------------------
.. automodule:: tools.modelsim.modelsim
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: tools.modelsim
:members:
:undoc-members:
:show-inheritance:
tools.planahead package
=======================
Submodules
----------
tools.planahead.planahead module
--------------------------------
.. automodule:: tools.planahead.planahead
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: tools.planahead
:members:
:undoc-members:
:show-inheritance:
tools.quartus package
=====================
Submodules
----------
tools.quartus.quartus module
----------------------------
.. automodule:: tools.quartus.quartus
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: tools.quartus
:members:
:undoc-members:
:show-inheritance:
tools package
=============
Subpackages
-----------
.. toctree::
tools.aldec
tools.diamond
tools.ghdl
tools.ise
tools.isim
tools.iverilog
tools.libero
tools.modelsim
tools.planahead
tools.quartus
Module contents
---------------
.. automodule:: tools
:members:
:undoc-members:
:show-inheritance:
util package
============
Submodules
----------
util.configparser module
------------------------
.. automodule:: util.configparser
:members:
:undoc-members:
:show-inheritance:
util.path module
----------------
.. automodule:: util.path
:members:
:undoc-members:
:show-inheritance:
util.termcolor module
---------------------
.. automodule:: util.termcolor
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: util
:members:
:undoc-members:
:show-inheritance:
vhdl_parser module
==================
.. automodule:: vhdl_parser
:members:
:undoc-members:
:show-inheritance:
vlog_parser module
==================
.. automodule:: vlog_parser
:members:
:undoc-members:
:show-inheritance:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment