diff options
| author | jwansek <eddie.atten.ea29@gmail.com> | 2022-05-24 18:57:52 +0100 |
|---|---|---|
| committer | jwansek <eddie.atten.ea29@gmail.com> | 2022-05-24 18:57:52 +0100 |
| commit | 6a3e91c8a2e01ab8a516b9f11be76c783e67827c (patch) | |
| tree | 1f37ecd988bd67df4dbf911d277b5bc9f981187b | |
| parent | 221bd14fa9a4177904e2d2e8d17e867f1fcd0783 (diff) | |
| download | Smarker-6a3e91c8a2e01ab8a516b9f11be76c783e67827c.tar.gz Smarker-6a3e91c8a2e01ab8a516b9f11be76c783e67827c.zip | |
| -rw-r--r-- | ExampleAssessments/smol.yml | 22 | ||||
| -rw-r--r-- | docs/requirements.txt | 4 | ||||
| -rw-r--r-- | docs/source/conf.py | 6 | ||||
| -rw-r--r-- | docs/source/index.rst | 5 |
4 files changed, 13 insertions, 24 deletions
diff --git a/ExampleAssessments/smol.yml b/ExampleAssessments/smol.yml deleted file mode 100644 index 22937d7..0000000 --- a/ExampleAssessments/smol.yml +++ /dev/null @@ -1,22 +0,0 @@ -files: - - pjtool.py: - classes: - - Date: - methods: - - __init__(4) - - __str__(1) - - __eq__(2) - - __lt__(2) - - numYears(2) - - numMonths(2) - - AnotherClass: - methods: - - floofleBerries(2) - tests: - - | - d1 = Date(2001, 8, 12) - d2 = Date(2001, 8, 12) - return d1 == d2 - - aNonExistantModule.py: - functions: - - aNonExistantFunction(1)
\ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt index bced0aa..eef5792 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,5 @@ Sphinx
sphinx_mdinclude
-sphinx-argparse
\ No newline at end of file +sphinx-argparse
+sphinx_toolbox
+markupsafe
diff --git a/docs/source/conf.py b/docs/source/conf.py index a168856..a55e222 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -35,8 +35,12 @@ extensions = [ 'sphinx.ext.coverage', 'sphinx.ext.napoleon', "sphinx_mdinclude", - 'sphinxarg.ext' + 'sphinxarg.ext', + "sphinx_toolbox.sidebar_links", + 'sphinx_toolbox.github' ] +github_username = 'jwansek' +github_repository = 'Smarker' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/source/index.rst b/docs/source/index.rst index 80fefaf..e4930f1 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -62,6 +62,9 @@ Also see :ref:`assessments` assessments.rst api.rst +.. sidebar-links:: + :caption: Source code: + :github: Indices and tables ================== @@ -69,3 +72,5 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` +* `Source Code <https://git.eda.gay/Smarker/files.html>`_ +* `License <https://git.eda.gay/Smarker/file/LICENSE.html>`_ |