From 129e63ab8c102a64b94060ab1d59972465dfce27 Mon Sep 17 00:00:00 2001 From: Mike Hendricks Date: Fri, 29 Jul 2022 18:09:47 -0700 Subject: [PATCH] Remove .rst files from git --- .gitignore | 1 + docs/source/casement.rst | 18 ------------------ docs/source/casement.shortcut.rst | 7 ------- docs/source/casement.test.rst | 7 ------- docs/source/conf.py | 5 ++++- 5 files changed, 5 insertions(+), 33 deletions(-) delete mode 100644 docs/source/casement.rst delete mode 100644 docs/source/casement.shortcut.rst delete mode 100644 docs/source/casement.test.rst diff --git a/.gitignore b/.gitignore index 5f7962b..111bedf 100644 --- a/.gitignore +++ b/.gitignore @@ -40,6 +40,7 @@ output/*/index.html # Sphinx docs/build +*.rst # Cookie Cutter output/ diff --git a/docs/source/casement.rst b/docs/source/casement.rst deleted file mode 100644 index 3118ed1..0000000 --- a/docs/source/casement.rst +++ /dev/null @@ -1,18 +0,0 @@ -casement package -================ - -Submodules ----------- - -.. toctree:: - - casement.shortcut - casement.test - -Module contents ---------------- - -.. automodule:: casement - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/casement.shortcut.rst b/docs/source/casement.shortcut.rst deleted file mode 100644 index a6b29bc..0000000 --- a/docs/source/casement.shortcut.rst +++ /dev/null @@ -1,7 +0,0 @@ -casement.shortcut module -======================== - -.. automodule:: casement.shortcut - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/casement.test.rst b/docs/source/casement.test.rst deleted file mode 100644 index da2a99a..0000000 --- a/docs/source/casement.test.rst +++ /dev/null @@ -1,7 +0,0 @@ -casement.test module -==================== - -.. automodule:: casement.test - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py index 3bb9a69..d858dd2 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -15,7 +15,10 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -# + +# Command to build documentation +# `sphinx-apidoc -o ./docs/source casement tests ./setup.py -e -f && sphinx-build -b html ./docs/source ./docs/build/preview` + import os import sys import distutils.core