Skip to content

Commit ed9f54c

Browse files
michaelraczyckitwiecki
michaelraczycki
authored and
twiecki
committed
doctest setup with solved merge conflicts
1 parent 78b9cc9 commit ed9f54c

File tree

2 files changed

+258
-0
lines changed

2 files changed

+258
-0
lines changed

‎docs/source/conf.py

+214
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
# Copyright 2022 The PyMC Developers
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
16+
#
17+
# Configuration file for the Sphinx documentation builder.
18+
#
19+
# This file does only contain a selection of the most common options. For a
20+
# full list see the documentation:
21+
# http://www.sphinx-doc.org/en/master/config
22+
23+
# -- Path setup --------------------------------------------------------------
24+
25+
# If extensions (or modules to document with autodoc) are in another directory,
26+
# add these directories to sys.path here. If the directory is relative to the
27+
# documentation root, use os.path.abspath to make it absolute, like shown here.
28+
#
29+
import os
30+
import sys
31+
32+
import pymc_experimental # isort:skip
33+
34+
sys.path.insert(0, os.path.abspath("../"))
35+
36+
# -- Project information -----------------------------------------------------
37+
38+
project = "pymc_experimental"
39+
copyright = "2022, pymc-devs"
40+
author = "pymc-devs"
41+
42+
# The short X.Y version
43+
version = pymc_experimental.__version__
44+
# The full version, including alpha/beta/rc tags
45+
release = version
46+
47+
48+
# -- General configuration ---------------------------------------------------
49+
50+
# If your documentation needs a minimal Sphinx version, state it here.
51+
#
52+
# needs_sphinx = '1.0'
53+
54+
# Add any Sphinx extension module names here, as strings. They can be
55+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
56+
# ones.
57+
extensions = [
58+
"sphinx.ext.autodoc",
59+
"sphinx.ext.doctest",
60+
"sphinx.ext.autosummary",
61+
"sphinx.ext.viewcode",
62+
"sphinx.ext.napoleon",
63+
"sphinx.ext.mathjax",
64+
"nbsphinx",
65+
"matplotlib.sphinxext.plot_directive",
66+
]
67+
68+
nbsphinx_execute = "never"
69+
70+
# Add any paths that contain templates here, relative to this directory.
71+
templates_path = ["_templates"]
72+
73+
# The suffix(es) of source filenames.
74+
# You can specify multiple suffix as a list of string:
75+
#
76+
# source_suffix = ['.rst', '.md']
77+
source_suffix = ".rst"
78+
79+
# The master toctree document.
80+
master_doc = "index"
81+
82+
# The language for content autogenerated by Sphinx. Refer to documentation
83+
# for a list of supported languages.
84+
#
85+
# This is also used if you do content translation via gettext catalogs.
86+
# Usually you set "language" from the command line for these cases.
87+
# language = None
88+
89+
# List of patterns, relative to source directory, that match files and
90+
# directories to ignore when looking for source files.
91+
# This pattern also affects html_static_path and html_extra_path.
92+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]
93+
94+
# The name of the Pygments (syntax highlighting) style to use.
95+
pygments_style = "sphinx"
96+
97+
98+
# -- Options for HTML output -------------------------------------------------
99+
100+
# The theme to use for HTML and HTML Help pages. See the documentation for
101+
# a list of builtin themes.
102+
#
103+
html_theme = "pymc_sphinx_theme"
104+
105+
# Theme options are theme-specific and customize the look and feel of a theme
106+
# further. For a list of options available for each theme, see the
107+
# documentation.
108+
109+
# https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/configuring.html#remove-the-sidebar-from-some-pages
110+
111+
html_theme_options = {
112+
"collapse_navigation": True,
113+
"show_toc_level": 2,
114+
"navigation_depth": 4,
115+
"search_bar_text": "Search the docs...",
116+
"use_search_override": False,
117+
"logo": {"text": project},
118+
}
119+
html_context = {
120+
"github_user": "pymc-devs",
121+
"github_repo": "pymc-experimental",
122+
"github_version": "main",
123+
"doc_path": "docs",
124+
"default_mode": "light",
125+
}
126+
127+
128+
# Add any paths that contain custom static files (such as style sheets) here,
129+
# relative to this directory. They are copied after the builtin static files,
130+
# so a file named "default.css" will overwrite the builtin "default.css".
131+
html_static_path = ["../_static"]
132+
133+
# -- Options for HTMLHelp output ---------------------------------------------
134+
135+
# Output file base name for HTML help builder.
136+
htmlhelp_basename = "pymc_experimentaldoc"
137+
138+
139+
# -- Options for LaTeX output ------------------------------------------------
140+
141+
latex_elements = {
142+
# The paper size ('letterpaper' or 'a4paper').
143+
#
144+
# 'papersize': 'letterpaper',
145+
# The font size ('10pt', '11pt' or '12pt').
146+
#
147+
# 'pointsize': '10pt',
148+
# Additional stuff for the LaTeX preamble.
149+
#
150+
# 'preamble': '',
151+
# Latex figure (float) alignment
152+
#
153+
# 'figure_align': 'htbp',
154+
}
155+
156+
# Grouping the document tree into LaTeX files. List of tuples
157+
# (source start file, target name, title,
158+
# author, documentclass [howto, manual, or own class]).
159+
latex_documents = [
160+
(
161+
master_doc,
162+
"pymc_experimental.tex",
163+
"pymc_experimental Documentation",
164+
"The developers of pymc_experimental",
165+
"manual",
166+
),
167+
]
168+
169+
170+
# -- Options for manual page output ------------------------------------------
171+
172+
# One entry per manual page. List of tuples
173+
# (source start file, name, description, authors, manual section).
174+
man_pages = [(master_doc, "pymc_experimental", "pymc_experimental Documentation", [author], 1)]
175+
176+
177+
# -- Options for Texinfo output ----------------------------------------------
178+
179+
# Grouping the document tree into Texinfo files. List of tuples
180+
# (source start file, target name, title, author,
181+
# dir menu entry, description, category)
182+
texinfo_documents = [
183+
(
184+
master_doc,
185+
"pymc_experimental",
186+
"pymc_experimental Documentation",
187+
author,
188+
"pymc_experimental",
189+
"One line description of project.",
190+
"Miscellaneous",
191+
),
192+
]
193+
194+
195+
# -- Options for Epub output -------------------------------------------------
196+
197+
# Bibliographic Dublin Core info.
198+
epub_title = project
199+
200+
# The unique identifier of the text. This can be a ISBN number
201+
# or the project homepage.
202+
#
203+
# epub_identifier = ''
204+
205+
# A unique identification for the text.
206+
#
207+
# epub_uid = ''
208+
209+
# A list of files that should not be packed into the epub file.
210+
epub_exclude_files = ["search.html"]
211+
212+
213+
# -- Extension configuration -------------------------------------------------
214+
# https://svn.python.org/projects/external/Jinja-1.1/docs/build/designerdoc.html

‎docs/source/index.rst

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
PyMC experimental
2+
===================================================
3+
|Tests|
4+
|Coverage|
5+
|Black|
6+
7+
8+
.. |Tests| image:: https://github.com/pymc-devs/pymc-experimental/actions/workflows/test.yml/badge.svg
9+
:target: https://github.com/pymc-devs/pymc-experimental
10+
11+
.. |Coverage| image:: https://codecov.io/gh/pymc-devs/pymc-experimental/branch/main/graph/badge.svg?token=ZqH0KCLKAE
12+
:target: https://codecov.io/gh/pymc-devs/pymc-experimental
13+
14+
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
15+
:target: https://github.com/ambv/black
16+
17+
18+
19+
Where we grow the next batch of cool PyMC features
20+
21+
22+
Dependencies
23+
============
24+
PyMC experimental is tested on Python 3.8+ and depends on PyMC V5.
25+
26+
Installation
27+
============
28+
29+
.. code-block:: bash
30+
31+
pip install git+https://github.com/pymc-devs/pymc-experimental.git
32+
33+
Contributing
34+
============
35+
We welcome contributions from interested individuals or groups! For information about contributing to PyMC experimental check out our instructions, policies, and guidelines `here <https://github.com/pymc-devs/pymc-experimental/blob/main/CONTRIBUTING.md>`_.
36+
37+
Contributors
38+
============
39+
See the `GitHub contributor page <https://github.com/pymc-devs/pymc-experimental/graphs/contributors>`_.
40+
41+
.. toctree::
42+
:hidden:
43+
44+
api_reference <https://www.pymc.io/projects/experimental/en/latest/api_reference.html>

0 commit comments

Comments
 (0)