Skip to content

H
Hdlmake
Commit 1666bf9a authored by Javier D. Garcia-Lasheras's avatar Javier D. Garcia-Lasheras
Browse files
Options

Start refactoring Sphinx documentation

parent 6d6ec1a1
Hide whitespace changes
Inline Side-by-side
Showing with 23 additions and 269 deletions
docs/hdlmake.action.rst
View file @ 1666bf9a
......@@ -12,98 +12,26 @@ hdlmake.action.action module
:undoc-members:
:show-inheritance:
hdlmake.action.check_condition module
hdlmake.action.core module
-------------------------------------
.. automodule:: hdlmake.action.check_condition
.. automodule:: hdlmake.action.core
:members:
:undoc-members:
:show-inheritance:
hdlmake.action.check_manifest module
hdlmake.action.tree module
------------------------------------
.. automodule:: hdlmake.action.check_manifest
.. automodule:: hdlmake.action.tree
:members:
:undoc-members:
:show-inheritance:
hdlmake.action.clean module
---------------------------
hdlmake.action.qsys_hw_tcl_update module
----------------------------------------
.. automodule:: hdlmake.action.clean
:members:
:undoc-members:
:show-inheritance:
hdlmake.action.fetch module
---------------------------
.. automodule:: hdlmake.action.fetch
:members:
:undoc-members:
:show-inheritance:
hdlmake.action.fetch_makefile module
------------------------------------
.. automodule:: hdlmake.action.fetch_makefile
:members:
:undoc-members:
:show-inheritance:
hdlmake.action.list_files module
--------------------------------
.. automodule:: hdlmake.action.list_files
:members:
:undoc-members:
:show-inheritance:
hdlmake.action.list_modules module
----------------------------------
.. automodule:: hdlmake.action.list_modules
:members:
:undoc-members:
:show-inheritance:
hdlmake.action.merge_cores module
---------------------------------
.. automodule:: hdlmake.action.merge_cores
:members:
:undoc-members:
:show-inheritance:
hdlmake.action.remote_synthesis module
--------------------------------------
.. automodule:: hdlmake.action.remote_synthesis
:members:
:undoc-members:
:show-inheritance:
hdlmake.action.simulation module
--------------------------------
.. automodule:: hdlmake.action.simulation
:members:
:undoc-members:
:show-inheritance:
hdlmake.action.synthesis module
-------------------------------
.. automodule:: hdlmake.action.synthesis
:members:
:undoc-members:
:show-inheritance:
hdlmake.action.synthesis_project module
---------------------------------------
.. automodule:: hdlmake.action.synthesis_project
.. automodule:: hdlmake.action.qsys_hw_tcl_update
:members:
:undoc-members:
:show-inheritance:
......
docs/hdlmake.rst
View file @ 1666bf9a
......@@ -22,18 +22,10 @@ hdlmake.dep_file module
:undoc-members:
:show-inheritance:
hdlmake.dep_solver module
hdlmake.new_dep_solver module
-------------------------
.. automodule:: hdlmake.dep_solver
:members:
:undoc-members:
:show-inheritance:
hdlmake.dependable_file module
------------------------------
.. automodule:: hdlmake.dependable_file
.. automodule:: hdlmake.new_dep_solver
:members:
:undoc-members:
:show-inheritance:
......@@ -46,22 +38,6 @@ hdlmake.env module
:undoc-members:
:show-inheritance:
hdlmake.global_mod module
-------------------------
.. automodule:: hdlmake.global_mod
:members:
:undoc-members:
:show-inheritance:
hdlmake.makefile_writer module
------------------------------
.. automodule:: hdlmake.makefile_writer
:members:
:undoc-members:
:show-inheritance:
hdlmake.manifest_parser module
------------------------------
......@@ -86,14 +62,6 @@ hdlmake.module_pool module
:undoc-members:
:show-inheritance:
hdlmake.new_dep_solver module
-----------------------------
.. automodule:: hdlmake.new_dep_solver
:members:
:undoc-members:
:show-inheritance:
hdlmake.srcfile module
----------------------
......
docs/hdlmake.tools.aldec.rst → docs/hdlmake.tools.active_hdl.rst
View file @ 1666bf9a
hdlmake.tools.aldec package
hdlmake.tools.active_hdl package
===========================
Submodules
----------
hdlmake.tools.aldec.aldec module
--------------------------------
.. automodule:: hdlmake.tools.aldec.aldec
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: hdlmake.tools.aldec
.. automodule:: hdlmake.tools.active_hdl
:members:
:undoc-members:
:show-inheritance:
docs/hdlmake.tools.common.rst
View file @ 1666bf9a
hdlmake.tools.common package
============================
Submodules
----------
hdlmake.tools.common.sim_makefile_support module
------------------------------------------------
.. automodule:: hdlmake.tools.common.sim_makefile_support
:members:
:undoc-members:
:show-inheritance:
hdlmake.tools.sim_makefile_support package
==========================================
Module contents
---------------
.. automodule:: hdlmake.tools.common
.. automodule:: hdlmake.tools.sim_makefile_support
:members:
:undoc-members:
:show-inheritance:
docs/hdlmake.tools.diamond.rst
View file @ 1666bf9a
hdlmake.tools.diamond package
=============================
Submodules
----------
hdlmake.tools.diamond.diamond module
------------------------------------
.. automodule:: hdlmake.tools.diamond.diamond
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
docs/hdlmake.tools.ghdl.rst
View file @ 1666bf9a
hdlmake.tools.ghdl package
==========================
Submodules
----------
hdlmake.tools.ghdl.ghdl module
------------------------------
.. automodule:: hdlmake.tools.ghdl.ghdl
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
docs/hdlmake.tools.ise.rst
View file @ 1666bf9a
hdlmake.tools.ise package
=========================
Submodules
----------
hdlmake.tools.ise.ise module
----------------------------
.. automodule:: hdlmake.tools.ise.ise
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
docs/hdlmake.tools.isim.rst
View file @ 1666bf9a
hdlmake.tools.isim package
==========================
Submodules
----------
hdlmake.tools.isim.isim module
------------------------------
.. automodule:: hdlmake.tools.isim.isim
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
docs/hdlmake.tools.iverilog.rst
View file @ 1666bf9a
hdlmake.tools.iverilog package
==============================
Submodules
----------
hdlmake.tools.iverilog.iverilog module
--------------------------------------
.. automodule:: hdlmake.tools.iverilog.iverilog
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
docs/hdlmake.tools.libero.rst
View file @ 1666bf9a
hdlmake.tools.libero package
============================
Submodules
----------
hdlmake.tools.libero.libero module
----------------------------------
.. automodule:: hdlmake.tools.libero.libero
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
docs/hdlmake.tools.modelsim.rst
View file @ 1666bf9a
hdlmake.tools.modelsim package
==============================
Submodules
----------
hdlmake.tools.modelsim.modelsim module
--------------------------------------
.. automodule:: hdlmake.tools.modelsim.modelsim
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
docs/hdlmake.tools.planahead.rst
View file @ 1666bf9a
hdlmake.tools.planahead package
===============================
Submodules
----------
hdlmake.tools.planahead.planahead module
----------------------------------------
.. automodule:: hdlmake.tools.planahead.planahead
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
docs/hdlmake.tools.quartus.rst
View file @ 1666bf9a
hdlmake.tools.quartus package
=============================
Submodules
----------
hdlmake.tools.quartus.quartus module
------------------------------------
.. automodule:: hdlmake.tools.quartus.quartus
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
docs/hdlmake.tools.riviera.rst
View file @ 1666bf9a
hdlmake.tools.riviera package
=============================
Submodules
----------
hdlmake.tools.riviera.riviera module
------------------------------------
.. automodule:: hdlmake.tools.riviera.riviera
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
docs/hdlmake.tools.rst
View file @ 1666bf9a
......@@ -6,7 +6,7 @@ Subpackages
.. toctree::
hdlmake.tools.aldec
hdlmake.tools.active_hdl
hdlmake.tools.common
hdlmake.tools.diamond
hdlmake.tools.ghdl
......
docs/hdlmake.tools.vivado.rst
View file @ 1666bf9a
hdlmake.tools.vivado package
============================
Submodules
----------
hdlmake.tools.vivado.vivado module
----------------------------------
.. automodule:: hdlmake.tools.vivado.vivado
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
......
docs/hdlmake.util.rst
View file @ 1666bf9a
......@@ -4,14 +4,6 @@ hdlmake.util package
Submodules
----------
hdlmake.util.configparser module
--------------------------------
.. automodule:: hdlmake.util.configparser
:members:
:undoc-members:
:show-inheritance:
hdlmake.util.path module
------------------------
......
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