diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f70521e..22cf63d 100644 --- 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 index d0c3cbf..d4bb2cb 100644 --- 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 b/docs/api.rst similarity index 100% rename from docs/source/api.rst rename to docs/api.rst diff --git a/docs/source/conf.py b/docs/conf.py similarity index 91% rename from docs/source/conf.py rename to docs/conf.py index fddf8f2..9a2f7f3 100644 --- a/docs/source/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = 'sqlalchemyseed' -copyright = '2021, jedymatt' +copyright = '2022, jedymatt' author = 'jedymatt' @@ -37,7 +37,7 @@ # 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 ------------------------------------------------- @@ -45,10 +45,10 @@ # 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'] \ No newline at end of file +html_static_path = ['_static'] diff --git a/docs/source/examples.rst b/docs/examples.rst similarity index 100% rename from docs/source/examples.rst rename to docs/examples.rst diff --git a/docs/source/index.rst b/docs/index.rst similarity index 90% rename from docs/source/index.rst rename to docs/index.rst index 8edeb4d..226c714 100644 --- a/docs/source/index.rst +++ b/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 b/docs/intro.rst similarity index 100% rename from docs/source/intro.rst rename to docs/intro.rst diff --git a/docs/make.bat b/docs/make.bat index 061f32f..954237b 100644 --- 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 b/docs/relationships.rst similarity index 100% rename from docs/source/relationships.rst rename to docs/relationships.rst diff --git a/docs/requirements.txt b/docs/requirements.txt index 8f0c3b8..1cae0ff 100644 --- 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 b/docs/seeding.rst similarity index 100% rename from docs/source/seeding.rst rename to docs/seeding.rst diff --git a/docs/source/_static/.gitkeep b/docs/source/_static/.gitkeep deleted file mode 100644 index e69de29..0000000