Changes. You know how it is.

rhgrant10 · Apr 7, 2020 · 50e9bf3 · 50e9bf3
1 parent a2d1058
commit 50e9bf3
Show file tree

Hide file tree

Showing 21 changed files with 798 additions and 598 deletions.
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -0,0 +1,3 @@
+.highlight .go {
+    color: hsla(0, 0%, 50%, .8);
+}
diff --git a/docs/authors.rst b/docs/authors.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -97,7 +97,9 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-
+html_context = {
+    'css_files': ['_static/css/custom.css'],
+}
 
 # -- Options for HTMLHelp output ---------------------------------------
 

diff --git a/docs/contributing.rst b/docs/contributing.rst
diff --git a/docs/history.rst b/docs/history.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,13 +5,13 @@ Welcome to TSPLIB 95's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   readme
-   installation
-   usage
-   modules
-   contributing
-   authors
-   history
+   pages/readme
+   pages/installation
+   pages/usage
+   pages/modules
+   pages/contributing
+   pages/authors
+   pages/history
 
 Indices and tables
 ==================

diff --git a/docs/modules.rst b/docs/modules.rst
diff --git a/docs/pages/authors.rst b/docs/pages/authors.rst
@@ -0,0 +1 @@
+.. include:: ../../AUTHORS.rst
diff --git a/docs/pages/contributing.rst b/docs/pages/contributing.rst
@@ -0,0 +1 @@
+.. include:: ../../CONTRIBUTING.rst
diff --git a/docs/pages/history.rst b/docs/pages/history.rst
@@ -0,0 +1 @@
+.. include:: ../../HISTORY.rst
diff --git a/docs/installation.rst → docs/pages/installation.rst b/docs/installation.rst → docs/pages/installation.rst
diff --git a/docs/pages/modules.rst b/docs/pages/modules.rst
@@ -0,0 +1,80 @@
+API Documentation
+=================
+
+
+Loaders
+-------
+
+The loaders are responsible for loading from a filepath, reading a file-like
+object, or parsing a string.
+
+.. automodule:: tsplib95.loaders
+    :members:
+    :show-inheritance:
+
+
+Problems
+--------
+
+Problem classes define what fields can be present and how they are converted
+to and from text.
+
+.. automodule:: tsplib95.models
+    :members:
+    :show-inheritance:
+
+
+Fields
+------
+
+.. automodule:: tsplib95.fields
+    :members:
+    :show-inheritance:
+
+
+Transformers
+------------
+
+.. automodule:: tsplib95.transformers
+    :members:
+    :show-inheritance:
+
+
+Matrices
+--------
+
+.. automodule:: tsplib95.matrix
+    :members:
+    :show-inheritance:
+
+
+Distances
+---------
+
+.. automodule:: tsplib95.distances
+    :members:
+    :show-inheritance:
+
+
+Biseps
+------
+
+.. automodule:: tsplib95.bisep
+    :members:
+    :show-inheritance:
+
+
+Utilities
+---------
+
+.. automodule:: tsplib95.utils
+    :members:
+    :show-inheritance:
+
+
+Exceptions
+----------
+
+.. automodule:: tsplib95.exceptions
+    :members:
+    :show-inheritance:
diff --git a/docs/pages/readme.rst b/docs/pages/readme.rst
@@ -0,0 +1 @@
+.. include:: ../../README.rst