diff --git a/.readthedocs.yml b/.readthedocs.yml index 63712e52..5b37e32f 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,7 +1,7 @@ version: 2 sphinx: - configuration: src/conf.py + configuration: doc/conf.py fail_on_warning: false formats: diff --git a/.vscode/settings.json b/.vscode/settings.json index c236ad1f..f07a994f 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -44,7 +44,7 @@ "python.testing.pytestEnabled": false, "python.testing.unittestEnabled": false, "restructuredtext.builtDocumentationPath": "${workspaceFolder}/build/html", - "restructuredtext.confPath": "${workspaceFolder}/src/conf.py", + "restructuredtext.confPath": "${workspaceFolder}/doc/conf.py", "rewrap.wrappingColumn": 79, "telemetry.enableCrashReporter": false, "telemetry.enableTelemetry": false diff --git a/Makefile b/Makefile index 165db807..e5f80a2f 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ # from the environment for the first two. SPHINXOPTS ?= -T -W --keep-going SPHINXBUILD ?= sphinx-build -SOURCEDIR = src +SOURCEDIR = doc BUILDDIR = build # Put it first so that "make" without argument is like "make help". diff --git a/src/analysis.rst b/doc/analysis.rst similarity index 100% rename from src/analysis.rst rename to doc/analysis.rst diff --git a/src/analysis/fit.rst b/doc/analysis/fit.rst similarity index 100% rename from src/analysis/fit.rst rename to doc/analysis/fit.rst diff --git a/src/analysis/statistics.rst b/doc/analysis/statistics.rst similarity index 100% rename from src/analysis/statistics.rst rename to doc/analysis/statistics.rst diff --git a/src/analysis/visualization.rst b/doc/analysis/visualization.rst similarity index 100% rename from src/analysis/visualization.rst rename to doc/analysis/visualization.rst diff --git a/src/conf.py b/doc/conf.py similarity index 99% rename from src/conf.py rename to doc/conf.py index 399f50fa..52d6ed11 100644 --- a/src/conf.py +++ b/doc/conf.py @@ -64,7 +64,7 @@ html_theme_options = { "repository_url": "https://github.com/ComPWA/PWA-pages", "repository_branch": "master", - "path_to_docs": "src", + "path_to_docs": "doc", "use_edit_page_button": True, "use_issues_button": True, "use_repository_button": True, diff --git a/src/index.rst b/doc/index.rst similarity index 100% rename from src/index.rst rename to doc/index.rst diff --git a/src/pwa_pages/__init__.py b/doc/pwa_pages/__init__.py similarity index 100% rename from src/pwa_pages/__init__.py rename to doc/pwa_pages/__init__.py diff --git a/src/pwa_pages/py.typed b/doc/pwa_pages/py.typed similarity index 100% rename from src/pwa_pages/py.typed rename to doc/pwa_pages/py.typed diff --git a/src/software.rst b/doc/software.rst similarity index 100% rename from src/software.rst rename to doc/software.rst diff --git a/src/software/documentation.rst b/doc/software/documentation.rst similarity index 100% rename from src/software/documentation.rst rename to doc/software/documentation.rst diff --git a/src/software/git.rst b/doc/software/git.rst similarity index 100% rename from src/software/git.rst rename to doc/software/git.rst diff --git a/src/software/git/branching.rst b/doc/software/git/branching.rst similarity index 100% rename from src/software/git/branching.rst rename to doc/software/git/branching.rst diff --git a/src/software/git/commit.rst b/doc/software/git/commit.rst similarity index 100% rename from src/software/git/commit.rst rename to doc/software/git/commit.rst diff --git a/src/software/git/github.rst b/doc/software/git/github.rst similarity index 100% rename from src/software/git/github.rst rename to doc/software/git/github.rst diff --git a/src/software/git/remotes.rst b/doc/software/git/remotes.rst similarity index 100% rename from src/software/git/remotes.rst rename to doc/software/git/remotes.rst diff --git a/src/software/python.rst b/doc/software/python.rst similarity index 100% rename from src/software/python.rst rename to doc/software/python.rst diff --git a/src/software/testing.rst b/doc/software/testing.rst similarity index 100% rename from src/software/testing.rst rename to doc/software/testing.rst diff --git a/src/software/tips.rst b/doc/software/tips.rst similarity index 100% rename from src/software/tips.rst rename to doc/software/tips.rst diff --git a/src/theory.rst b/doc/theory.rst similarity index 100% rename from src/theory.rst rename to doc/theory.rst diff --git a/src/theory/bibliography.bib b/doc/theory/bibliography.bib similarity index 100% rename from src/theory/bibliography.bib rename to doc/theory/bibliography.bib diff --git a/src/theory/data.rst b/doc/theory/data.rst similarity index 100% rename from src/theory/data.rst rename to doc/theory/data.rst diff --git a/src/theory/dynamics.ipynb b/doc/theory/dynamics.ipynb similarity index 100% rename from src/theory/dynamics.ipynb rename to doc/theory/dynamics.ipynb diff --git a/src/theory/formalisms.rst b/doc/theory/formalisms.rst similarity index 100% rename from src/theory/formalisms.rst rename to doc/theory/formalisms.rst diff --git a/src/theory/glossary.rst b/doc/theory/glossary.rst similarity index 100% rename from src/theory/glossary.rst rename to doc/theory/glossary.rst diff --git a/src/theory/introduction.rst b/doc/theory/introduction.rst similarity index 100% rename from src/theory/introduction.rst rename to doc/theory/introduction.rst diff --git a/src/theory/results.rst b/doc/theory/results.rst similarity index 100% rename from src/theory/results.rst rename to doc/theory/results.rst diff --git a/src/theory/topics.rst b/doc/theory/topics.rst similarity index 100% rename from src/theory/topics.rst rename to doc/theory/topics.rst diff --git a/src/theory/topics/cqm.rst b/doc/theory/topics/cqm.rst similarity index 100% rename from src/theory/topics/cqm.rst rename to doc/theory/topics/cqm.rst diff --git a/src/theory/topics/sm.rst b/doc/theory/topics/sm.rst similarity index 100% rename from src/theory/topics/sm.rst rename to doc/theory/topics/sm.rst diff --git a/src/theory/z.references.rst b/doc/theory/z.references.rst similarity index 100% rename from src/theory/z.references.rst rename to doc/theory/z.references.rst diff --git a/environment.yml b/environment.yml index e82e7dc1..830fd337 100644 --- a/environment.yml +++ b/environment.yml @@ -1,7 +1,7 @@ name: pwa-pages channels: - - conda-forge - defaults + - conda-forge dependencies: - python>=3.6 - pip diff --git a/pyproject.toml b/pyproject.toml index 19e51ed7..88796793 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,5 +33,5 @@ exclude = ''' [tool.isort] profile = "black" -src_paths = ["src/pwa_pages"] +src_paths = ["doc/pwa_pages"] line_length = 79 diff --git a/pyrightconfig.json b/pyrightconfig.json index aaa30761..2ea49f24 100644 --- a/pyrightconfig.json +++ b/pyrightconfig.json @@ -1,6 +1,6 @@ { "exclude": [".git", ".tox"], - "include": ["setup.py", "src"], + "include": ["setup.py", "doc"], "reportGeneralTypeIssues": false, "reportUnboundVariable": false, "reportUnusedClass": true, diff --git a/setup.cfg b/setup.cfg index d6e44ded..e964cb3b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -34,10 +34,10 @@ install_requires = numpy==1.19.2 packages = find: package_dir = - =src + =doc [options.packages.find] -where = src +where = doc include = pwa_pages diff --git a/tox.ini b/tox.ini index 13c99949..51a35554 100644 --- a/tox.ini +++ b/tox.ini @@ -41,10 +41,10 @@ commands = [flake8] application-import-names = pwa_pages filename = - ./src/*.py + ./doc/*.py exclude = __pycache__ - src/conf.py + doc/conf.py ignore = # more info: https://www.flake8rules.com/ B305 # progress.Bar.next() E203 # https://github.com/psf/black#slices