Skip to content

Commit

Permalink
WIP docs config
Browse files Browse the repository at this point in the history
  • Loading branch information
interdoc committed Oct 3, 2019
1 parent 109d405 commit 818e3d1
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 8 deletions.
6 changes: 6 additions & 0 deletions docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{% extends "!layout.html" %}

{% block document %}
HELLO WORLD

{% endblock %}
7 changes: 4 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_autodoc_typehints", # Must come *after* sphinx.ext.napoleon.
# "sphinx_autodoc_typehints", # Must come *after* sphinx.ext.napoleon.
"sphinx.ext.autosummary",
"sphinx.ext.coverage",
"sphinx.ext.doctest",
Expand Down Expand Up @@ -39,8 +39,9 @@
# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get("READTHEDOCS", None) == "True"

if not on_rtd: # only set the theme if we"re building docs locally
html_theme = "sphinx_rtd_theme"

html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]

html_use_smartypants = True
html_last_updated_fmt = "%b %d, %Y"
Expand Down
31 changes: 26 additions & 5 deletions docs/reference/interdoc.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,30 @@
interdoc
========
interdoc package
================

.. testsetup::
Submodules
----------

from interdoc import *
interdoc.app module
-------------------

.. automodule:: interdoc.app
:members:
:undoc-members:
:show-inheritance:

interdoc.cli module
-------------------

.. automodule:: interdoc.cli
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: interdoc
:members:
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/reference/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src
===

.. toctree::
:maxdepth: 4

interdoc
4 changes: 4 additions & 0 deletions docs/theme.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[theme]
inherit = default
stylesheet = style.css
pygments_style = pygments.css
4 changes: 4 additions & 0 deletions docs/theme/theme.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[theme]
inherit = default
stylesheet = style.css
pygments_style = pygments.css

0 comments on commit 818e3d1

Please sign in to comment.