Add viewcode functionality

Support for viewing the source listings of autodocumented C modules has
now been added.

closes: #4

Author: speedyleion

.pylintrc

@@ -197,7 +197,7 @@ valid-classmethod-first-arg=mcs,cls
 
 # these are common "protected" variable names that are usually acceptable
 # to access. For example, the ._fields attribute on a namedtuple()
-exclude-protected=_asdict,_fields,_replace,_source,_make
+exclude-protected=_asdict,_fields,_replace,_source,_make,_viewcode_c_modules
 
 
 [DESIGN]

CHANGELOG.rst

@@ -9,6 +9,12 @@ This project adheres to `Semantic Versioning <https://semver.org/>`_.
 `v0.2.0-dev`_ (unreleased)
 ==========================
 
+Added
+-----
+
+* Viewcode functionality which allows for listing the source C files and
+  providing links between the documentation and the C source listings.
+
 Fixes
 -----
 

docs/_api/modules.rst

@@ -1,7 +1,7 @@
 :orphan:
 
-src
-===
+sphinx_c_autodoc
+================
 
 .. toctree::
    :maxdepth: 4

docs/_api/sphinx_c_autodoc.clang.comments.rst

@@ -4,10 +4,22 @@ sphinx\_c\_autodoc.clang package
 Submodules
 ----------
 
-.. toctree::
+sphinx\_c\_autodoc.clang.comments module
+----------------------------------------
+
+.. automodule:: sphinx_c_autodoc.clang.comments
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+sphinx\_c\_autodoc.clang.patches module
+---------------------------------------
+
+.. automodule:: sphinx_c_autodoc.clang.patches
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-   sphinx_c_autodoc.clang.comments
-   sphinx_c_autodoc.clang.patches
 
 Module contents
 ---------------

docs/_api/sphinx_c_autodoc.clang.patches.rst

@@ -0,0 +1,22 @@
+sphinx\_c\_autodoc.domains package
+==================================
+
+Submodules
+----------
+
+sphinx\_c\_autodoc.domains.c module
+-----------------------------------
+
+.. automodule:: sphinx_c_autodoc.domains.c
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: sphinx_c_autodoc.domains
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/_api/sphinx_c_autodoc.clang.rst

@@ -7,14 +7,21 @@ Subpackages
 .. toctree::
 
    sphinx_c_autodoc.clang
+   sphinx_c_autodoc.domains
    sphinx_c_autodoc.napoleon
+   sphinx_c_autodoc.viewcode
 
 Submodules
 ----------
 
-.. toctree::
+sphinx\_c\_autodoc.loader module
+--------------------------------
+
+.. automodule:: sphinx_c_autodoc.loader
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-   sphinx_c_autodoc.loader
 
 Module contents
 ---------------

docs/_api/sphinx_c_autodoc.domains.rst

@@ -0,0 +1,10 @@
+sphinx\_c\_autodoc.viewcode package
+===================================
+
+Module contents
+---------------
+
+.. automodule:: sphinx_c_autodoc.viewcode
+   :members:
+   :undoc-members:
+   :show-inheritance: