Skip to content

Commit 4b79f87

Browse files
mcgibbonmcgibbon
committed
Initial docs from cookiecutter
1 parent 6a65b99 commit 4b79f87

10 files changed

+301
-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 = python -msphinx
7+
SPHINXPROJ = marble
8+
SOURCEDIR = .
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/authors.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../AUTHORS.rst

‎docs/conf.py

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

‎docs/contributing.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../CONTRIBUTING.rst

‎docs/history.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../HISTORY.rst

‎docs/index.rst

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Welcome to MARBLE's documentation!
2+
======================================
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
:caption: Contents:
7+
8+
readme
9+
installation
10+
usage
11+
modules
12+
contributing
13+
authors
14+
history
15+
16+
Indices and tables
17+
==================
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`

‎docs/installation.rst

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
.. highlight:: shell
2+
3+
============
4+
Installation
5+
============
6+
7+
8+
Stable release
9+
--------------
10+
11+
To install MARBLE, run this command in your terminal:
12+
13+
.. code-block:: console
14+
15+
$ pip install marble
16+
17+
This is the preferred method to install MARBLE, as it will always install the most recent stable release.
18+
19+
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
20+
you through the process.
21+
22+
.. _pip: https://pip.pypa.io
23+
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
24+
25+
26+
From sources
27+
------------
28+
29+
The sources for MARBLE can be downloaded from the `Github repo`_.
30+
31+
You can either clone the public repository:
32+
33+
.. code-block:: console
34+
35+
$ git clone git://github.com/mcgibbon/marble
36+
37+
Or download the `tarball`_:
38+
39+
.. code-block:: console
40+
41+
$ curl -OL https://github.com/mcgibbon/marble/tarball/master
42+
43+
Once you have a copy of the source, you can install it with:
44+
45+
.. code-block:: console
46+
47+
$ python setup.py install
48+
49+
50+
.. _Github repo: https://github.com/mcgibbon/marble
51+
.. _tarball: https://github.com/mcgibbon/marble/tarball/master

‎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=python -msphinx
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
set SPHINXPROJ=marble
13+
14+
if "%1" == "" goto help
15+
16+
%SPHINXBUILD% >NUL 2>NUL
17+
if errorlevel 9009 (
18+
echo.
19+
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
20+
echo.then set the SPHINXBUILD environment variable to point to the full
21+
echo.path of the 'sphinx-build' executable. Alternatively you may add the
22+
echo.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/readme.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../README.rst

‎docs/usage.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
=====
2+
Usage
3+
=====
4+
5+
To use MARBLE in a project::
6+
7+
import marble

0 commit comments

Comments
 (0)