Skip to content
This repository has been archived by the owner on Aug 24, 2022. It is now read-only.

Commit

Permalink
change docs stuff a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
anatskiy committed Jan 25, 2017
1 parent 69f87f2 commit fadb5ef
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 22 deletions.
4 changes: 2 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = Parkour
SOURCEDIR = .
BUILDDIR = _build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
Expand Down
29 changes: 14 additions & 15 deletions docs/conf.py → docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# -*- coding: utf-8 -*-
#
# Parkour documentation build configuration file, created by
# sphinx-quickstart on Mon Jan 23 17:20:46 2017.
# sphinx-quickstart on Wed Jan 25 00:59:55 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
Expand All @@ -20,7 +20,7 @@
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

import datetime

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

Expand All @@ -31,13 +31,15 @@
# 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',
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.todo',
'sphinx.ext.viewcode']
'sphinx.ext.viewcode',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ['ntemplates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
Expand All @@ -50,29 +52,29 @@

# General information about the project.
project = 'Parkour'
copyright = '2017, Evgeny Anatskiy'
copyright = str(datetime.datetime.now().year) + ', Evgeny Anatskiy'
author = 'Evgeny Anatskiy'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '3.5'
# version = ''
# The full version, including alpha/beta/rc tags.
release = '3.5.2'
# release = ''

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
Expand All @@ -86,7 +88,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
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 All @@ -97,7 +99,7 @@
# 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']
html_static_path = ['nstatic']


# -- Options for HTMLHelp output ------------------------------------------
Expand Down Expand Up @@ -155,6 +157,3 @@
author, 'Parkour', 'One line description of project.',
'Miscellaneous'),
]



5 changes: 0 additions & 5 deletions docs/index.rst → docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
.. Parkour documentation master file, created by
sphinx-quickstart on Mon Jan 23 17:20:46 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Parkour's documentation!
===================================

Expand Down
4 changes: 4 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ cryptography==1.5.2
dj-database-url==0.4.2
Django==1.10.2
django-authtools==1.5.0
django-tastypie==0.13.3
docutils==0.13.1
ecdsa==0.13
Fabric3==1.12.post1
Expand All @@ -26,6 +27,8 @@ pycparser==2.14
pycrypto==2.6.1
Pygments==2.2.0
pyperclip==1.5.27
python-dateutil==2.6.0
python-mimeparse==1.6.0
pytz==2016.10
PyYAML==3.12
reportlab==3.3.0
Expand All @@ -34,6 +37,7 @@ six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.5.2
sphinx-autobuild==0.6.0
sphinx-rtd-theme==0.1.9
tornado==4.4.2
watchdog==0.8.3
xlwt==1.1.2

0 comments on commit fadb5ef

Please sign in to comment.