Skip to content

Commit

Permalink
Add ReadTheDocs Config
Browse files Browse the repository at this point in the history
Signed-off-by: alexgurrola <alexgurrola1@gmail.com>
  • Loading branch information
alexgurrola committed Oct 15, 2019
1 parent 86460c5 commit 93b8db8
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 1 deletion.
23 changes: 23 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
#sphinx:
# configuration: docs/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

# Optionally set the version of Python and requirements required to build your docs
#python:
# version: 3.7
# install:
# - requirements: docs/requirements.txt
62 changes: 61 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,62 @@
# from source/conf.py import *
# -*- coding: utf-8 -*-

from __future__ import division, print_function, unicode_literals

import os
import sys
from configparser import RawConfigParser

import sphinx_rtd_theme

sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.dirname(__file__))
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "readthedocs.settings.dev")

from django.utils import timezone

import django

django.setup()

sys.path.append(os.path.abspath('_ext'))
extensions = [
'sphinx.ext.autosectionlabel',
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinxcontrib.httpdomain',
'djangodocs',
'doc_extensions',
'sphinx_tabs.tabs',
'sphinx-prompt',
'recommonmark',
'notfound.extension',
'sphinx_search.extension',
]
# templates_path = ['_templates']

source_suffix = ['.rst']

master_doc = 'index'
project = u'Sitetheory'
copyright = '2015-{}, Sitetheory'.format(
timezone.now().year
)
version = '1.0'
release = version
# exclude_patterns = ['_build']
# default_role = 'obj'
language = 'en'

# locale_dirs = [
# 'locale/',
# ]
gettext_compact = False

html_theme = 'sphinx_rtd_theme'
# html_static_path = ['_static']
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# html_logo = 'img/logo.svg'
html_theme_options = {
'logo_only': False,
'display_version': True,
}
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Django==2.2.5
sphinx_rtd_theme==0.4.3

0 comments on commit 93b8db8

Please sign in to comment.