Skip to content

Commit d032205

Browse files
Add Sphinx configuration files
1 parent 4bc470f commit d032205

4 files changed

Lines changed: 93 additions & 0 deletions

File tree

docs/conf.py

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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 os
10+
import sys
11+
sys.path.insert(0, os.path.abspath('../src/'))
12+
13+
project = 'Simple JustWatch Python API'
14+
copyright = '2023, Electronic-Mango'
15+
author = 'Electronic-Mango'
16+
17+
# -- General configuration ---------------------------------------------------
18+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
19+
20+
extensions = [
21+
'sphinx.ext.autodoc',
22+
'sphinx.ext.viewcode',
23+
'sphinx.ext.napoleon'
24+
]
25+
26+
templates_path = ['_templates']
27+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
28+
29+
30+
31+
# -- Options for HTML output -------------------------------------------------
32+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
33+
34+
html_theme = 'sphinx_rtd_theme'
35+
html_static_path = ['_static']

docs/index.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. Simple JustWatch Python API documentation master file, created by
2+
sphinx-quickstart on Sat Nov 25 15:12:37 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 Simple JustWatch Python API's documentation!
7+
=======================================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
modules
14+
15+
16+
17+
Indices and tables
18+
==================
19+
20+
* :ref:`genindex`
21+
* :ref:`modindex`
22+
* :ref:`search`

docs/modules.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
simplejustwatchapi
2+
==================
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
simplejustwatchapi

docs/simplejustwatchapi.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
simplejustwatchapi package
2+
==========================
3+
4+
Submodules
5+
----------
6+
7+
simplejustwatchapi.justwatch module
8+
-----------------------------------
9+
10+
.. automodule:: simplejustwatchapi.justwatch
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
simplejustwatchapi.query module
16+
-------------------------------
17+
18+
.. automodule:: simplejustwatchapi.query
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: simplejustwatchapi
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

0 commit comments

Comments
 (0)