Merge pull request #37 from jedymatt/26-reorganize-docs-directory-str…

…ucture-to-default 26 reorganize docs directory structure to default
jedymatt · May 27, 2022 · a71895f · a71895f
2 parents e77d7f5 + 65fc5b3
commit a71895f
Show file tree

Hide file tree

Showing 12 changed files with 17 additions and 17 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -7,9 +7,9 @@ version: 2
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-    configuration: docs/source/conf.py
-    builder: singlehtml
-#    fail_on_warning: true
+    configuration: docs/conf.py
+    builder: html
+    # fail_on_warning: true
 
 # Optionally build your docs in additional formats such as PDF
 formats: all

diff --git a/docs/Makefile b/docs/Makefile
@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
+SOURCEDIR     = .
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/source/api.rst → docs/api.rst b/docs/source/api.rst → docs/api.rst
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → docs/conf.py
@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'sqlalchemyseed'
-copyright = '2021, jedymatt'
+copyright = '2022, jedymatt'
 author = 'jedymatt'
 
 
@@ -37,18 +37,18 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-# html_theme = "alabaster"
-html_theme = "sphinx_rtd_theme"
+# html_theme = 'alabaster'
+html_theme = 'furo'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static']
diff --git a/docs/source/examples.rst → docs/examples.rst b/docs/source/examples.rst → docs/examples.rst
diff --git a/docs/source/index.rst → docs/index.rst b/docs/source/index.rst → docs/index.rst
@@ -1,5 +1,5 @@
 .. sqlalchemyseed documentation master file, created by
-   sphinx-quickstart on Sat Sep 25 14:41:54 2021.
+   sphinx-quickstart on Fri May 27 23:04:46 2022.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
@@ -15,7 +15,7 @@ Project Links: `Github`_ | `PyPI`_
 
 .. toctree::
     :maxdepth: 2
-    :caption: Contents
+    :caption: Contents:
 
     intro
     seeding

diff --git a/docs/source/intro.rst → docs/intro.rst b/docs/source/intro.rst → docs/intro.rst
diff --git a/docs/make.bat b/docs/make.bat
@@ -7,10 +7,8 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=source
-set BUILDDIR=build
-
-if "%1" == "" goto help
+set SOURCEDIR=.
+set BUILDDIR=_build
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
@@ -25,6 +23,8 @@ if errorlevel 9009 (
 	exit /b 1
 )
 
+if "%1" == "" goto help
+
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 

diff --git a/docs/source/relationships.rst → docs/relationships.rst b/docs/source/relationships.rst → docs/relationships.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
-sphinx_rtd_theme>=1.0
 sphinx>=4.3
+furo
diff --git a/docs/source/seeding.rst → docs/seeding.rst b/docs/source/seeding.rst → docs/seeding.rst
diff --git a/docs/source/_static/.gitkeep b/docs/source/_static/.gitkeep