Skip to content

Commit f9e10ca

Browse files
rlishtabarlishtaba
committed
Adding docs template
1 parent 9d24425 commit f9e10ca

File tree

4 files changed

+231
-0
lines changed

4 files changed

+231
-0
lines changed

‎docs/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = PythonAlgorithmsandDataStructures
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
set SPHINXPROJ=PythonAlgorithmsandDataStructures
13+
14+
if "%1" == "" goto help
15+
16+
%SPHINXBUILD% >NUL 2>NUL
17+
if errorlevel 9009 (
18+
echo.
19+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
20+
echo.installed, then set the SPHINXBUILD environment variable to point
21+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
22+
echo.may add the Sphinx directory to PATH.
23+
echo.
24+
echo.If you don't have Sphinx installed, grab it from
25+
echo.http://sphinx-doc.org/
26+
exit /b 1
27+
)
28+
29+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30+
goto end
31+
32+
:help
33+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34+
35+
:end
36+
popd

‎docs/source/conf.py

+155
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
#!/usr/bin/env python3
2+
# -*- coding: utf-8 -*-
3+
#
4+
# Python Algorithms and Data Structures documentation build configuration file, created by
5+
# sphinx-quickstart on Sun Oct 1 15:28:43 2017.
6+
#
7+
# This file is execfile()d with the current directory set to its
8+
# containing dir.
9+
#
10+
# Note that not all possible configuration values are present in this
11+
# autogenerated file.
12+
#
13+
# All configuration values have a default; values that are commented out
14+
# serve to show the default.
15+
# If extensions (or modules to document with autodoc) are in another directory,
16+
# add these directories to sys.path here. If the directory is relative to the
17+
# documentation root, use os.path.abspath to make it absolute, like shown here.
18+
#
19+
# import os
20+
# import sys
21+
# sys.path.insert(0, os.path.abspath('.'))
22+
# -- General configuration ------------------------------------------------
23+
# If your documentation needs a minimal Sphinx version, state it here.
24+
#
25+
# needs_sphinx = '1.0'
26+
# Add any Sphinx extension module names here, as strings. They can be
27+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
28+
# ones.
29+
extensions = ['sphinx.ext.doctest',
30+
'sphinx.ext.imgmath',
31+
'sphinx.ext.githubpages']
32+
33+
# Add any paths that contain templates here, relative to this directory.
34+
templates_path = ['_templates']
35+
36+
# The suffix(es) of source filenames.
37+
# You can specify multiple suffix as a list of string:
38+
#
39+
# source_suffix = ['.rst', '.md']
40+
source_suffix = '.rst'
41+
42+
# The master toctree document.
43+
master_doc = 'index'
44+
45+
# General information about the project.
46+
project = 'Python Algorithms and Data Structures'
47+
copyright = '2017, Roman Lishtaba'
48+
author = 'Roman Lishtaba'
49+
50+
# The version info for the project you're documenting, acts as replacement for
51+
# |version| and |release|, also used in various other places throughout the
52+
# built documents.
53+
#
54+
# The short X.Y version.
55+
version = '0.15.0'
56+
# The full version, including alpha/beta/rc tags.
57+
release = '0.15.0'
58+
59+
# The language for content autogenerated by Sphinx. Refer to documentation
60+
# for a list of supported languages.
61+
#
62+
# This is also used if you do content translation via gettext catalogs.
63+
# Usually you set "language" from the command line for these cases.
64+
language = None
65+
66+
# List of patterns, relative to source directory, that match files and
67+
# directories to ignore when looking for source files.
68+
# This patterns also effect to html_static_path and html_extra_path
69+
exclude_patterns = []
70+
71+
# The name of the Pygments (syntax highlighting) style to use.
72+
pygments_style = 'sphinx'
73+
74+
# If true, `todo` and `todoList` produce output, else they produce nothing.
75+
todo_include_todos = False
76+
77+
78+
# -- Options for HTML output ----------------------------------------------
79+
80+
# The theme to use for HTML and HTML Help pages. See the documentation for
81+
# a list of builtin themes.
82+
#
83+
html_theme = 'alabaster'
84+
85+
# Theme options are theme-specific and customize the look and feel of a theme
86+
# further. For a list of options available for each theme, see the
87+
# documentation.
88+
#
89+
# html_theme_options = {}
90+
91+
# Add any paths that contain custom static files (such as style sheets) here,
92+
# relative to this directory. They are copied after the builtin static files,
93+
# so a file named "default.css" will overwrite the builtin "default.css".
94+
html_static_path = ['_static']
95+
96+
97+
# -- Options for HTMLHelp output ------------------------------------------
98+
99+
# Output file base name for HTML help builder.
100+
htmlhelp_basename = 'PythonAlgorithmsandDataStructuresdoc'
101+
102+
103+
# -- Options for LaTeX output ---------------------------------------------
104+
105+
latex_elements = {
106+
# The paper size ('letterpaper' or 'a4paper').
107+
#
108+
# 'papersize': 'letterpaper',
109+
110+
# The font size ('10pt', '11pt' or '12pt').
111+
#
112+
# 'pointsize': '10pt',
113+
114+
# Additional stuff for the LaTeX preamble.
115+
#
116+
# 'preamble': '',
117+
118+
# Latex figure (float) alignment
119+
#
120+
# 'figure_align': 'htbp',
121+
}
122+
123+
# Grouping the document tree into LaTeX files. List of tuples
124+
# (source start file, target name, title,
125+
# author, documentclass [howto, manual, or own class]).
126+
latex_documents = [
127+
(master_doc, 'PythonAlgorithmsandDataStructures.tex',
128+
'Python Algorithms and Data Structures Documentation',
129+
'Roman Lishtaba', 'manual'),
130+
]
131+
132+
133+
# -- Options for manual page output ---------------------------------------
134+
135+
# One entry per manual page. List of tuples
136+
# (source start file, name, description, authors, manual section).
137+
man_pages = [
138+
(master_doc, 'pythonalgorithmsanddatastructures',
139+
'Python Algorithms and Data Structures Documentation',
140+
[author], 1)
141+
]
142+
143+
144+
# -- Options for Texinfo output -------------------------------------------
145+
146+
# Grouping the document tree into Texinfo files. List of tuples
147+
# (source start file, target name, title, author,
148+
# dir menu entry, description, category)
149+
texinfo_documents = [
150+
(master_doc, 'PythonAlgorithmsandDataStructures',
151+
'Python Algorithms and Data Structures Documentation',
152+
author, 'PythonAlgorithmsandDataStructures',
153+
'One line description of project.',
154+
'Miscellaneous'),
155+
]

‎docs/source/index.rst

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. Python Algorithms and Data Structures documentation master file, created by
2+
sphinx-quickstart on Sun Oct 1 15:28:43 2017.
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 Python Algorithms and Data Structures's documentation!
7+
=================================================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`

0 commit comments

Comments
 (0)