Finalize docs files

TDKorn · TDKorn · commit e2223681e2cf · 2023-02-23T20:31:46.000-05:00
diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css
@@ -16,3 +16,8 @@ code.literal {
 .wy-nav-top {
     background: #747373;
 }
+/* Change viewcode "[source]" link position and colour (blue) */
+.rst-content .viewcode-back, .rst-content .viewcode-link {
+    color: #00e;
+    padding-left: 12px;
+}
diff --git a/docs/source/add_linkcode_class.rst b/docs/source/add_linkcode_class.rst
@@ -1,3 +1,6 @@
+.. |.github_style| replace:: ``github_style.css``
+.. _.github_style: https://github.com/tdkorn/sphinx-github-style/tree/v1.0.0/sphinx_github_style/_static/github_style.css
+
 The ``add_linkcode_class`` module
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -6,5 +9,27 @@ Add Linkcode Class for CSS Styling
 .. automodule:: sphinx_github_style.add_linkcode_class
    :members:
    :undoc-members:
+   :exclude-members: setup
+
+
+The |.github_style|_ StyleSheet
+==================================
+
+Links are styled as follows:
+
+
+.. literalinclude:: ../../sphinx_github_style/_static/github_style.css
+   :language: css
+
+
+
+To make the ``viewcode-link`` links match with the ``linkcode-link`` links,
+add the following to your ``custom.css`` file:
 
+.. code-block:: css
 
+    /* Change viewcode "[source]" link position and colour to match linkcode */
+    .rst-content .viewcode-back, .rst-content .viewcode-link {
+        color: #00e;
+        padding-left: 12px;
+    }
diff --git a/docs/source/github_style.rst b/docs/source/github_style.rst
@@ -1,8 +1,10 @@
 The ``github_style`` module
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-GitHub Pygments Style Dark Theme
+:class:`~.TDKStyle` - GitHub Dark Theme Pygments Style
+===========================================================
 
 .. automodule:: sphinx_github_style.github_style
    :members:
    :undoc-members:
+   :exclude-members: setup
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,9 +4,3 @@
 .. include:: README.rst
 
 
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs/source/meth_lexer.rst b/docs/source/meth_lexer.rst
@@ -6,4 +6,6 @@ The ``meth_lexer`` module
 .. automodule:: sphinx_github_style.meth_lexer
    :members:
    :undoc-members:
+   :exclude-members: setup
+
 
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -6,9 +6,11 @@ The ``sphinx_github_style`` Package
    :members:
    :undoc-members:
 
+|
 
 .. toctree::
    :caption: Modules
+   :titlesonly:
 
    add_linkcode_class
    github_style

Original file line number	Diff line number	Diff line change
`@@ -16,3 +16,8 @@ code.literal {`
`16`	`16`	`.wy-nav-top {`
`17`	`17`	`background: #747373;`
`18`	`18`	`}`
	`19`	`+/* Change viewcode "[source]" link position and colour (blue) */`
	`20`	`+.rst-content .viewcode-back, .rst-content .viewcode-link {`
	`21`	`+ color: #00e;`
	`22`	`+ padding-left: 12px;`
	`23`	`+}`