From 57e4b94ba29cf42d9544fc73fc65567f46b29125 Mon Sep 17 00:00:00 2001 From: Josh Lay Date: Tue, 25 Apr 2023 21:17:22 -0500 Subject: [PATCH] add doc source info --- docs/.gitignore | 1 + docs/source/conf.py | 39 +++++++++++++++++++++++++++++++++++++++ docs/source/index.rst | 23 +++++++++++++++++++++++ docs/source/reference.rst | 6 ++++++ 4 files changed, 69 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/reference.rst diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..a007fea --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +build/* diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..37dafdb --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,39 @@ +import os +import sys + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +sys.path.insert(0, os.path.abspath(os.path.join("..", "..", "src"))) + +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'amdgpu_stats' +copyright = '2023, Josh Lay' +author = 'Josh Lay' +release = '0.1.6' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ["sphinx.ext.autodoc", + "sphinx.ext.napoleon", + "sphinx_rtd_theme"] + +templates_path = ['_templates'] +exclude_patterns = [] + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'sphinx_rtd_theme' +html_static_path = ['_static'] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..d3bb727 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,23 @@ +.. amdgpu_stats documentation master file, created by + sphinx-quickstart on Tue Apr 25 18:45:11 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to amdgpu_stats's documentation! +======================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + reference + + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/reference.rst b/docs/source/reference.rst new file mode 100644 index 0000000..cb02247 --- /dev/null +++ b/docs/source/reference.rst @@ -0,0 +1,6 @@ +``amdgpu_stats`` API reference +================================= + +.. automodule:: amdgpu_stats.utils + :members: +