Skip to content

Commit

Permalink
Merge pull request #63 from rpc4django/docs-updates
Browse files Browse the repository at this point in the history
Documentation updates
  • Loading branch information
davidfischer committed Oct 6, 2020
2 parents 58cfb81 + e8ee88f commit 3e0d8ab
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 3 deletions.
12 changes: 12 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: 2
formats: all

sphinx:
configuration: docs/conf.py

python:
version: 3.7
install:
- method: pip
path: .
- requirements: docs-requirements.txt
2 changes: 2 additions & 0 deletions docs-requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Sphinx==2.4.2
sphinx-rtd-theme==0.4.3
Empty file added docs/_static/.gitkeep
Empty file.
19 changes: 16 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,22 @@
import sys
from datetime import datetime

BASE_DIR = os.path.abspath(
os.path.join(os.path.dirname(os.path.abspath(__file__)), "..")
)

# 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.append(os.path.abspath('.'))
sys.path.append(BASE_DIR)


# Get __version__ without loading rpc4django module
ns = {}
version_path = os.path.join(BASE_DIR, "rpc4django/version.py")
with open(version_path, "r", encoding="utf-8") as version_file:
exec(version_file.read(), ns)
rpc4django_version = ns["__version__"]

# -- General configuration -----------------------------------------------------

Expand Down Expand Up @@ -47,7 +59,8 @@
# built documents.
#
# The short X.Y version.
version = '0.6.3'
version = rpc4django_version

# The full version, including alpha/beta/rc tags.
release = version

Expand Down Expand Up @@ -93,7 +106,7 @@

# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = 'default'
html_theme = 'sphinx_rtd_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down

0 comments on commit 3e0d8ab

Please sign in to comment.