Skip to content

Commit 065b935

Browse files
skysomorphicskysomorphic
committed
set up sphinx docs
1 parent 80ed0d6 commit 065b935

13 files changed

Lines changed: 551 additions & 2 deletions

‎docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/api/qbreader.api_utils.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
qbreader.api\_utils module
2+
==========================
3+
4+
.. automodule:: qbreader.api_utils
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/api/qbreader.asynchronous.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
qbreader.asynchronous module
2+
============================
3+
4+
.. automodule:: qbreader.asynchronous
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/api/qbreader.consts.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
qbreader.consts module
2+
======================
3+
4+
.. automodule:: qbreader.consts
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/api/qbreader.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
qbreader package
2+
================
3+
4+
Submodules
5+
----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
qbreader.api_utils
11+
qbreader.asynchronous
12+
qbreader.consts
13+
qbreader.synchronous
14+
qbreader.types
15+
16+
Module contents
17+
---------------
18+
19+
.. automodule:: qbreader
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:

‎docs/api/qbreader.synchronous.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
qbreader.synchronous module
2+
===========================
3+
4+
.. automodule:: qbreader.synchronous
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/api/qbreader.types.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
qbreader.types module
2+
=====================
3+
4+
.. automodule:: qbreader.types
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/conf.py‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
import sys
10+
from os import path
11+
12+
import qbreader
13+
14+
sys.path.insert(0, path.abspath(".."))
15+
16+
project = 'python-qbreader'
17+
copyright = '2023, Sky Hong, Rohan Arni, Geoffrey Wu'
18+
author = 'Sky Hong, Rohan Arni, Geoffrey Wu'
19+
release = qbreader.__version__
20+
21+
# -- General configuration ---------------------------------------------------
22+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
23+
24+
extensions = [
25+
"sphinx.ext.autodoc",
26+
"sphinx.ext.duration",
27+
"sphinx.ext.intersphinx",
28+
"sphinx.ext.napoleon",
29+
]
30+
31+
templates_path = ['_templates']
32+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
33+
default_role = "py:obj"
34+
35+
36+
# -- Options for HTML output -------------------------------------------------
37+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
38+
39+
html_theme = 'furo'
40+
html_static_path = ['_static']
41+
42+
intersphinx_mapping = {
43+
"py": ("https://docs.python.org/3", None),
44+
}

‎docs/index.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. python-qbreader documentation master file, created by
2+
sphinx-quickstart on Fri Sep 22 19:37:45 2023.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to python-qbreader's documentation!
7+
===========================================
8+
9+
.. toctree::
10+
:hidden:
11+
:caption: API Reference
12+
13+
qbreader <api/qbreader>
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

0 commit comments

Comments
 (0)