Merge pull request #17 from kber-trumpf/list_of_paths

Add support for list of directories in `vhdl_autodoc_source_path`

Author: jakubcabal

doc/source/config.rst

@@ -9,4 +9,8 @@ Configuration options
 
   Determines the root of the directory structure where the VHDL source codes
   used for automatic documentation generation reside. Must be relative to from
-  where the build command is run.
+  where the build command is run.
+
+  In case project contains directories which You do not wish to parse, the 
+  list of directories can be also provided. Parsing will be done for each one 
+  in the order defined by the list. 

doc/source/directives_detailed.rst

@@ -241,9 +241,9 @@ Auto- Directives
     Automatically generates a documentation for an entity. Has one required
     argument, the  name of the entity. For the automatic generation to work,
     the :py:attr:`vhdl_autodoc_source_path` configuration option must be set to
-    point to a valid directory containing VHDL sources describing this entity.
-    See :ref:`autodoc_usage` for further instructions on how the source code
-    must be set up.
+    point to a valid directory (or list of directories) containing VHDL sources 
+    describing this entity. See :ref:`autodoc_usage` for further instructions 
+    on how the source code must be set up.
 
     .. rst:directive:option:: noautogenerics
 
@@ -260,71 +260,72 @@ Auto- Directives
     Automatically generates a documentation for an enumeration defined type.
     Has one required argument, the name of the type. For the automatic
     generation to work, the :py:attr:`vhdl_autodoc_source_path` configuration
-    option must be set to point to a valid directory containing VHDL sources
-    describing this entity. See :ref:`autodoc_usage` for further instructions
-    on how the source code must be set up.
+    option must be set to point to a valid directory (or list of directories) 
+    containing VHDL sources describing this entity. See :ref:`autodoc_usage` 
+    for further instructions on how the source code must be set up.
 
 .. rst:directive:: vhdl:autofunction
 
     Automatically generates a documentation for a pure function.
     Has one required argument, the name of the type. For the automatic
     generation to work, the :py:attr:`vhdl_autodoc_source_path` configuration
-    option must be set to point to a valid directory containing VHDL sources
-    describing this entity. See :ref:`autodoc_usage` for further instructions
-    on how the source code must be set up.
+    option must be set to point to a valid directory (or list of directories) 
+    containing VHDL sources describing this entity. See :ref:`autodoc_usage`
+    for further instructions on how the source code must be set up.
 
 .. rst:directive:: vhdl:autogenerics
 
     Automatically generates a documentation for an entity's generics. Has one
     required argument, the name of the entity whose generics to document. For
     the automatic generation to work, the :py:attr:`vhdl_autodoc_source_path`
-    configuration option must be set to point to a valid directory containing
-    VHDL sources describing the target entity.  See  :ref:`autodoc_usage` for
-    further instruction on how the source must be set up.
+    configuration option must be set to point to a valid directory (or list 
+    of directories)  containing VHDL sources describing the target entity.  
+    See  :ref:`autodoc_usage` for further instruction on how the source 
+    must be set up.
 
 .. rst:directive:: vhdl:autoconstants
 
     Automatically generates documentation for an architecture's constants. 
     Has one required argument, the name of the architecture whose constants 
     are to be documented. For the automatic generation to work, the 
     :py:attr:`vhdl_autodoc_source_path` configuration option must be set to 
-    point to a valid directory containing VHDL sources describing the target 
-    entity.  See  :ref:`autodoc_usage` for further instruction on how the 
-    source must be set up.
+    point to a valid directory (or list of directories) containing VHDL 
+    sources describing the target  entity.  See  :ref:`autodoc_usage` for 
+    further instruction on how the source must be set up.
 
 .. rst:directive:: vhdl:autopackage
 
     Automatically generates a documentation for a package. Has one required
     argument, the name of the package to document. For the automatic generation
     to work, the :py:attr:`vhdl_autodoc_source_path` configuration option must
-    be set to point to a valid directory containing VHDL sources defining the
-    target package. See :ref:`autodoc_usage` for further instructions on how
-    the source must be set up.
+    be set to point to a valid directory (or list of directories) containing 
+    VHDL sources defining the target package. See :ref:`autodoc_usage` for 
+    further instructions on how the source must be set up.
 
 .. rst:directive:: vhdl:autoports
 
     Automatically generates a documentation for an entity's ports. Has one
     required argument, the name of the entity whose ports to document. For the
     automatic generation to work, the :py:attr:`vhdl_autodoc_source_path`
-    configuration option must be set to point to a valid directory containing
-    VHDL sources describing the target entity. See :ref:`autodoc_usage` for
-    further instruction on how the source must be set up.
+    configuration option must be set to point to a valid directory (or list 
+    of directories) containing VHDL sources describing the target entity. 
+    See :ref:`autodoc_usage` for further instruction on how the source must be set up.
 
 .. rst:directive:: vhdl:autorecord
 
     Automatically generates a documentation for a record-defined type. Has one
     required argument, the name of the type to document. For the automatic
     generation to work, the :py:attr:`vhdl_autodoc_source_path` configuration
-    option must be set to point to a valid directory containing VHDL sources
-    describing the type. See :ref:`autodoc_usage` for further instructions on
-    how the source must be set up.
+    option must be set to point to a valid directory (or list of directories) 
+    containing VHDL sources describing the type. See :ref:`autodoc_usage` for 
+    further instructions on how the source must be set up.
 
 .. rst:directive:: vhdl:autotype
 
     Automatically generates a documentation for a type other than enumeration-
     record-defined one. Has one required argument, the name of the type to
     document. For the automatic generation to work, the
     :py:attr:`vhdl_autodoc_source_path` configuration option must be set to
-    point to a valid directory containing VHDL sources describing the type. See
-    :ref:`autodoc_usage` for further instructions on how the sources must be
-    set up.
+    point to a valid directory (or list of directories) containing VHDL sources 
+    describing the type. See :ref:`autodoc_usage` for further instructions on 
+    how the sources must be set up.

doc/source/index.rst

@@ -17,6 +17,14 @@ To setup sphinx-vhdl for your project, please edit your sphinx ``conf.py`` file
   extensions = ['sphinxvhdl.vhdl']
   vhdl_autodoc_source_path = 'path/to/your/vhdl/sources/root'
 
+In case VHDL source files reside in two different directories, You can specify a list 
+in :py:attr:`vhdl_autodoc_source_path`
+
+.. code-block:: python
+
+  extensions = ['sphinxvhdl.vhdl']
+  vhdl_autodoc_source_path = ['path/to/your/vhdl/sources1', 'path/to/your/vhdl/sources1']
+
 See :ref:`configuration` for more information.
 
 Recognized directives

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = sphinx-vhdl
-version = 0.2.0
+version = 0.2.1
 author = CESNET z.s.p.o.
 author_email = cabal@cesnet.cz
 description = A Sphinx domain and autodocumenter for VHDL