Move docs to docs-sphinx folder

proteanhq · Mar 23, 2024 · ab2f129 · ab2f129
1 parent f05094c
commit ab2f129
Show file tree

Hide file tree

Showing 36 changed files with 22 additions and 19 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -5,10 +5,10 @@ tag = True
 
 [bumpversion:file:pyproject.toml]
 
-[bumpversion:file:docs/conf.py]
+[bumpversion:file:docs-sphinx/conf.py]
 
 [bumpversion:file:src/protean/__init__.py]
 
 [bumpversion:file:src/protean/template/{{package_name}}/setup.py.jinja]
 
-[bumpversion:file:docs/user/installation.rst]
+[bumpversion:file:docs-sphinx/user/installation.rst]
diff --git a/.editorconfig b/.editorconfig
@@ -18,5 +18,5 @@ end_of_line = crlf
 [*.py]
 max_line_length = 119
 
-[docs/**.rst]
+[docs-sphinx/**.rst]
 max_line_length = 119
diff --git a/.flake8 b/.flake8
@@ -7,7 +7,7 @@ exclude =
     .tox,
     .git,
     __pycache__,
-    docs/source/conf.py,
+    docs-sphinx/source/conf.py,
     build,
     dist,
     conftest.py,

diff --git a/.gitignore b/.gitignore
@@ -66,7 +66,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+docs-sphinx/_build/
 
 # PyBuilder
 target/
@@ -136,7 +136,7 @@ output/*/index.html
 .vscode
 
 # Sphinx
-docs/.doctrees
+docs-sphinx/.doctrees
 
 # TODOs
 TODO

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -11,12 +11,12 @@ build:
   tools:
     python: "3.11"
 
-# Build documentation in the docs/ directory with Sphinx
+# Build documentation in the docs-sphinx/ directory with Sphinx
 sphinx:
-  configuration: docs/conf.py
+  configuration: docs-sphinx/conf.py
 
 # Explicitly set the version of Python and its requirements
 # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
   install:
-    - requirements: docs/requirements.txt
+    - requirements: docs-sphinx/requirements.txt
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -207,7 +207,7 @@ Read more about `coverage <https://coverage.readthedocs.io>`__.
 Building the docs
 `````````````````
 
-Build the docs in the ``docs`` directory using Sphinx.
+Build the docs in the ``docs-sphinx`` directory using Sphinx.
 
 .. code-block:: text
 

diff --git a/Makefile b/Makefile
@@ -14,7 +14,7 @@ down:
 	docker-compose down --remove-orphans
 
 html:
-	@cd docs; $(MAKE) html
+	@cd docs-sphinx; $(MAKE) html
 
 test-full: up
 	protean test

diff --git a/docs/Makefile → docs-sphinx/Makefile b/docs/Makefile → docs-sphinx/Makefile
diff --git a/docs/adapters/database.rst → docs-sphinx/adapters/database.rst b/docs/adapters/database.rst → docs-sphinx/adapters/database.rst
diff --git a/docs/api.rst → docs-sphinx/api.rst b/docs/api.rst → docs-sphinx/api.rst
diff --git a/docs/community/changelog.rst → docs-sphinx/community/changelog.rst b/docs/community/changelog.rst → docs-sphinx/community/changelog.rst
diff --git a/docs/community/code-of-conduct.rst → docs-sphinx/community/code-of-conduct.rst b/docs/community/code-of-conduct.rst → docs-sphinx/community/code-of-conduct.rst
diff --git a/docs/community/contributing.rst → docs-sphinx/community/contributing.rst b/docs/community/contributing.rst → docs-sphinx/community/contributing.rst
diff --git a/docs/conf.py → docs-sphinx/conf.py b/docs/conf.py → docs-sphinx/conf.py
@@ -3,6 +3,7 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
+import datetime
 import os
 
 extensions = [
@@ -25,7 +26,7 @@
 source_suffix = ".rst"
 master_doc = "index"
 project = "Protean"
-year = "2021"
+year = datetime.date.today().strftime("%Y")
 author = "Subhash Bhushan C"
 copyright = "{0}, {1}".format(year, author)
 version = release = "0.11.0"

diff --git a/docs/images/consuming-events.jpg → docs-sphinx/images/consuming-events.jpg b/docs/images/consuming-events.jpg → docs-sphinx/images/consuming-events.jpg
diff --git a/docs/images/raising-events.jpg → docs-sphinx/images/raising-events.jpg b/docs/images/raising-events.jpg → docs-sphinx/images/raising-events.jpg
diff --git a/docs/index.rst → docs-sphinx/index.rst b/docs/index.rst → docs-sphinx/index.rst
diff --git a/docs/make.bat → docs-sphinx/make.bat b/docs/make.bat → docs-sphinx/make.bat
diff --git a/docs-sphinx/requirements.txt b/docs-sphinx/requirements.txt
@@ -0,0 +1,3 @@
+livereload = ">=2.6.3"
+sphinx = ">=7.2.6"
+sphinx-tabs = ">=3.4.4"
diff --git a/docs/static/custom.css → docs-sphinx/static/custom.css b/docs/static/custom.css → docs-sphinx/static/custom.css
diff --git a/docs/user/cli.rst → docs-sphinx/user/cli.rst b/docs/user/cli.rst → docs-sphinx/user/cli.rst
diff --git a/docs/user/composing-a-domain.rst → docs-sphinx/user/composing-a-domain.rst b/docs/user/composing-a-domain.rst → docs-sphinx/user/composing-a-domain.rst
diff --git a/docs/user/config.rst → docs-sphinx/user/config.rst b/docs/user/config.rst → docs-sphinx/user/config.rst
diff --git a/docs/user/domain-definition.rst → docs-sphinx/user/domain-definition.rst b/docs/user/domain-definition.rst → docs-sphinx/user/domain-definition.rst
diff --git a/docs/user/entities-and-vos.rst → docs-sphinx/user/entities-and-vos.rst b/docs/user/entities-and-vos.rst → docs-sphinx/user/entities-and-vos.rst
diff --git a/docs/user/event-sourcing.rst → docs-sphinx/user/event-sourcing.rst b/docs/user/event-sourcing.rst → docs-sphinx/user/event-sourcing.rst
diff --git a/docs/user/eventing.rst → docs-sphinx/user/eventing.rst b/docs/user/eventing.rst → docs-sphinx/user/eventing.rst
diff --git a/docs/user/fields.rst → docs-sphinx/user/fields.rst b/docs/user/fields.rst → docs-sphinx/user/fields.rst
diff --git a/docs/user/foreword.rst → docs-sphinx/user/foreword.rst b/docs/user/foreword.rst → docs-sphinx/user/foreword.rst
diff --git a/docs/user/installation.rst → docs-sphinx/user/installation.rst b/docs/user/installation.rst → docs-sphinx/user/installation.rst
diff --git a/docs/user/persistence.rst → docs-sphinx/user/persistence.rst b/docs/user/persistence.rst → docs-sphinx/user/persistence.rst
diff --git a/docs/user/quickstart.rst → docs-sphinx/user/quickstart.rst b/docs/user/quickstart.rst → docs-sphinx/user/quickstart.rst
diff --git a/docs/user/services.rst → docs-sphinx/user/services.rst b/docs/user/services.rst → docs-sphinx/user/services.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/src/protean/cli.py b/src/protean/cli.py
@@ -267,7 +267,7 @@ def livereload_docs():
     from livereload import Server, shell
 
     server = Server()
-    server.watch("docs/**/*.rst", shell("make html"))
+    server.watch("docs-sphinx/**/*.rst", shell("make html"))
     server.watch("./*.rst", shell("make html"))
     server.serve(root="build/html", debug=True)
 

diff --git a/tox.ini b/tox.ini
@@ -34,19 +34,19 @@ commands =
 setenv =
     SPELLCHECK=1
 commands =
-    sphinx-build -b spelling docs dist/docs
+    sphinx-build -b spelling docs-sphinx docs-sphinx/docs
 skip_install = true
 deps =
-    -r{toxinidir}/docs/requirements.txt
+    -r{toxinidir}/docs-sphinx/requirements.txt
     sphinxcontrib-spelling
     pyenchant
 
 [testenv:docs]
 deps =
-    -r{toxinidir}/docs/requirements.txt
+    -r{toxinidir}/docs-sphinx/requirements.txt
 commands =
-    sphinx-build {posargs:-E} -b html docs dist/docs
-    sphinx-build -b linkcheck docs dist/docs
+    sphinx-build {posargs:-E} -b html docs-sphinx dist/docs-sphinx
+    sphinx-build -b linkcheck docs-sphinx dist/docs-sphinx
 
 [testenv:check]
 deps =