Skip to content

Commit ce4c223

Browse files
tapaswenipathaktapaswenipathak
committed
Base for read the docs
1 parent 4b8f7c3 commit ce4c223

File tree

4 files changed

+271
-0
lines changed

4 files changed

+271
-0
lines changed

Diff for: ‎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 = OpenBuds
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)

Diff for: ‎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=OpenBuds
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

Diff for: ‎docs/source/conf.py

+195
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
#!/usr/bin/env python3
2+
# -*- coding: utf-8 -*-
3+
#
4+
# OpenBuds documentation build configuration file, created by
5+
# sphinx-quickstart on Sun Nov 26 08:56:50 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+
16+
# If extensions (or modules to document with autodoc) are in another directory,
17+
# add these directories to sys.path here. If the directory is relative to the
18+
# documentation root, use os.path.abspath to make it absolute, like shown here.
19+
#
20+
# import os
21+
# import sys
22+
# sys.path.insert(0, os.path.abspath('.'))
23+
24+
25+
# -- General configuration ------------------------------------------------
26+
27+
# If your documentation needs a minimal Sphinx version, state it here.
28+
#
29+
# needs_sphinx = '1.0'
30+
31+
# Add any Sphinx extension module names here, as strings. They can be
32+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33+
# ones.
34+
extensions = ['sphinx.ext.autodoc',
35+
'sphinx.ext.doctest',
36+
'sphinx.ext.todo',
37+
'sphinx.ext.coverage',
38+
'sphinx.ext.mathjax',
39+
'sphinx.ext.githubpages']
40+
41+
# Add any paths that contain templates here, relative to this directory.
42+
templates_path = ['_templates']
43+
44+
# The suffix(es) of source filenames.
45+
# You can specify multiple suffix as a list of string:
46+
#
47+
# source_suffix = ['.rst', '.md']
48+
source_suffix = '.rst'
49+
50+
# The master toctree document.
51+
master_doc = 'index'
52+
53+
# General information about the project.
54+
project = 'OpenBuds'
55+
copyright = '2017, OpenBuds'
56+
author = 'OpenBuds'
57+
58+
# The version info for the project you're documenting, acts as replacement for
59+
# |version| and |release|, also used in various other places throughout the
60+
# built documents.
61+
#
62+
# The short X.Y version.
63+
version = ''
64+
# The full version, including alpha/beta/rc tags.
65+
release = ''
66+
67+
# The language for content autogenerated by Sphinx. Refer to documentation
68+
# for a list of supported languages.
69+
#
70+
# This is also used if you do content translation via gettext catalogs.
71+
# Usually you set "language" from the command line for these cases.
72+
language = None
73+
74+
# List of patterns, relative to source directory, that match files and
75+
# directories to ignore when looking for source files.
76+
# This patterns also effect to html_static_path and html_extra_path
77+
exclude_patterns = []
78+
79+
# The name of the Pygments (syntax highlighting) style to use.
80+
pygments_style = 'sphinx'
81+
82+
# If true, `todo` and `todoList` produce output, else they produce nothing.
83+
todo_include_todos = True
84+
85+
86+
# -- Options for HTML output ----------------------------------------------
87+
88+
# The theme to use for HTML and HTML Help pages. See the documentation for
89+
# a list of builtin themes.
90+
#
91+
html_theme = 'alabaster'
92+
93+
# Theme options are theme-specific and customize the look and feel of a theme
94+
# further. For a list of options available for each theme, see the
95+
# documentation.
96+
#
97+
# html_theme_options = {}
98+
99+
# Add any paths that contain custom static files (such as style sheets) here,
100+
# relative to this directory. They are copied after the builtin static files,
101+
# so a file named "default.css" will overwrite the builtin "default.css".
102+
html_static_path = ['_static']
103+
104+
# Custom sidebar templates, must be a dictionary that maps document names
105+
# to template names.
106+
#
107+
# This is required for the alabaster theme
108+
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
109+
html_sidebars = {
110+
'**': [
111+
'relations.html', # needs 'show_related': True theme option to display
112+
'searchbox.html',
113+
]
114+
}
115+
116+
117+
# -- Options for HTMLHelp output ------------------------------------------
118+
119+
# Output file base name for HTML help builder.
120+
htmlhelp_basename = 'OpenBudsdoc'
121+
122+
123+
# -- Options for LaTeX output ---------------------------------------------
124+
125+
latex_elements = {
126+
# The paper size ('letterpaper' or 'a4paper').
127+
#
128+
# 'papersize': 'letterpaper',
129+
130+
# The font size ('10pt', '11pt' or '12pt').
131+
#
132+
# 'pointsize': '10pt',
133+
134+
# Additional stuff for the LaTeX preamble.
135+
#
136+
# 'preamble': '',
137+
138+
# Latex figure (float) alignment
139+
#
140+
# 'figure_align': 'htbp',
141+
}
142+
143+
# Grouping the document tree into LaTeX files. List of tuples
144+
# (source start file, target name, title,
145+
# author, documentclass [howto, manual, or own class]).
146+
latex_documents = [
147+
(master_doc, 'OpenBuds.tex', 'OpenBuds Documentation',
148+
'OpenBuds', 'manual'),
149+
]
150+
151+
152+
# -- Options for manual page output ---------------------------------------
153+
154+
# One entry per manual page. List of tuples
155+
# (source start file, name, description, authors, manual section).
156+
man_pages = [
157+
(master_doc, 'openbuds', 'OpenBuds Documentation',
158+
[author], 1)
159+
]
160+
161+
162+
# -- Options for Texinfo output -------------------------------------------
163+
164+
# Grouping the document tree into Texinfo files. List of tuples
165+
# (source start file, target name, title, author,
166+
# dir menu entry, description, category)
167+
texinfo_documents = [
168+
(master_doc, 'OpenBuds', 'OpenBuds Documentation',
169+
author, 'OpenBuds', 'One line description of project.',
170+
'Miscellaneous'),
171+
]
172+
173+
174+
175+
# -- Options for Epub output ----------------------------------------------
176+
177+
# Bibliographic Dublin Core info.
178+
epub_title = project
179+
epub_author = author
180+
epub_publisher = author
181+
epub_copyright = copyright
182+
183+
# The unique identifier of the text. This can be a ISBN number
184+
# or the project homepage.
185+
#
186+
# epub_identifier = ''
187+
188+
# A unique identification for the text.
189+
#
190+
# epub_uid = ''
191+
192+
# A list of files that should not be packed into the epub file.
193+
epub_exclude_files = ['search.html']
194+
195+

Diff for: ‎docs/source/index.rst

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. OpenBuds documentation master file, created by
2+
sphinx-quickstart on Sun Nov 26 08:56:50 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 OpenBuds'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)