Archived
1
1
Fork 0

add doc source info

This commit is contained in:
Josh Lay 2023-04-25 21:17:22 -05:00
parent 1f7885cc21
commit 57e4b94ba2
Signed by: jlay
GPG key ID: B265E45CACAD108A
4 changed files with 69 additions and 0 deletions

1
docs/.gitignore vendored Normal file
View file

@ -0,0 +1 @@
build/*

39
docs/source/conf.py Normal file
View file

@ -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']

23
docs/source/index.rst Normal file
View file

@ -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`

View file

@ -0,0 +1,6 @@
``amdgpu_stats`` API reference
=================================
.. automodule:: amdgpu_stats.utils
:members: