-
Notifications
You must be signed in to change notification settings - Fork 136
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fail elegantly when no source files are found
Fixes #324
- Loading branch information
Showing
4 changed files
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# -*- coding: utf-8 -*- | ||
|
||
templates_path = ["_templates"] | ||
source_suffix = ".rst" | ||
master_doc = "index" | ||
project = "pyexample" | ||
copyright = "2015, readthedocs" | ||
author = "readthedocs" | ||
version = "0.1" | ||
release = "0.1" | ||
language = None | ||
exclude_patterns = ["_build"] | ||
pygments_style = "sphinx" | ||
todo_include_todos = False | ||
html_theme = "alabaster" | ||
htmlhelp_basename = "pyexampledoc" | ||
extensions = ["sphinx.ext.autodoc", "autoapi.extension"] | ||
autoapi_type = "python" | ||
autoapi_dirs = ["example"] | ||
autoapi_python_class_content = "both" | ||
autoapi_options = [ | ||
"members", | ||
"undoc-members", # this is temporary until we add docstrings across the codebase | ||
"show-inheritance", | ||
"show-module-summary", | ||
"special-members", | ||
"imported-members", | ||
"inherited-members", | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
.. pyexample documentation master file, created by | ||
sphinx-quickstart on Fri May 29 13:34:37 2015. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
Welcome to pyexample's documentation! | ||
===================================== | ||
|
||
.. toctree:: | ||
|
||
autoapi/index | ||
|
||
Contents: | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters