Skip to content

Commit

Permalink
Add requirements.txt to docs
Browse files Browse the repository at this point in the history
- Add requirements file in docs.
- Add build parameters in config file of docs.
- Fix versioning to 'rc1' for release candidate.
  • Loading branch information
Mayitzin committed Aug 14, 2020
1 parent 020054f commit 181c191
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 32 deletions.
2 changes: 1 addition & 1 deletion ahrs/versioning.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
MAJOR = 0
MINOR = 3
PATCH = 0
RELEASE = "rc-1"
RELEASE = "rc1"

def get_version(short=False):
if short or RELEASE == "0":
Expand Down
41 changes: 10 additions & 31 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,33 +1,18 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- 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.

import os
from datetime import datetime
import sys
sys.path.insert(0, os.path.abspath('../../ahrs'))

# -- Project information -----------------------------------------------------

project = 'AHRS'
copyright = '2019-2020, Mario Garcia'
author = 'Mario Garcia'

# The full version, including alpha/beta/rc tags
release = '0.3'
copyright = '2019-{}, {}'.format(datetime.now().year, author)
release = '0.3.0-rc1'

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

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.mathjax',
Expand All @@ -40,24 +25,18 @@
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# Explicitly assign master document
master_doc = 'index'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
exclude_patterns = ['build']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Explicitly assign master document
master_doc = 'index'
2 changes: 2 additions & 0 deletions docs/source/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Sphinx>=3.0
sphinx_rtd_theme>=0.5

0 comments on commit 181c191

Please sign in to comment.