chore: rename source folder to doc (#30)

This is to mimic the folder structure of related projects Additional changes: * ci: set conda-forge channel second Otherwise, Conda will install Python 3.9
ComPWA · Oct 29, 2020 · cd1b691 · cd1b691
1 parent 4bb4dfb
commit cd1b691
Show file tree

Hide file tree

Showing 38 changed files with 11 additions and 11 deletions.
diff --git 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
@@ -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
@@ -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 → doc/analysis.rst b/src/analysis.rst → doc/analysis.rst
diff --git a/src/analysis/fit.rst → doc/analysis/fit.rst b/src/analysis/fit.rst → doc/analysis/fit.rst
diff --git a/src/analysis/statistics.rst → doc/analysis/statistics.rst b/src/analysis/statistics.rst → doc/analysis/statistics.rst
diff --git a/src/analysis/visualization.rst → doc/analysis/visualization.rst b/src/analysis/visualization.rst → doc/analysis/visualization.rst
diff --git a/src/conf.py → doc/conf.py b/src/conf.py → 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 → doc/index.rst b/src/index.rst → doc/index.rst
diff --git a/src/pwa_pages/__init__.py → doc/pwa_pages/__init__.py b/src/pwa_pages/__init__.py → doc/pwa_pages/__init__.py
diff --git a/src/pwa_pages/py.typed → doc/pwa_pages/py.typed b/src/pwa_pages/py.typed → doc/pwa_pages/py.typed
diff --git a/src/software.rst → doc/software.rst b/src/software.rst → doc/software.rst
diff --git a/src/software/documentation.rst → doc/software/documentation.rst b/src/software/documentation.rst → doc/software/documentation.rst
diff --git a/src/software/git.rst → doc/software/git.rst b/src/software/git.rst → doc/software/git.rst
diff --git a/src/software/git/branching.rst → doc/software/git/branching.rst b/src/software/git/branching.rst → doc/software/git/branching.rst
diff --git a/src/software/git/commit.rst → doc/software/git/commit.rst b/src/software/git/commit.rst → doc/software/git/commit.rst
diff --git a/src/software/git/github.rst → doc/software/git/github.rst b/src/software/git/github.rst → doc/software/git/github.rst
diff --git a/src/software/git/remotes.rst → doc/software/git/remotes.rst b/src/software/git/remotes.rst → doc/software/git/remotes.rst
diff --git a/src/software/python.rst → doc/software/python.rst b/src/software/python.rst → doc/software/python.rst
diff --git a/src/software/testing.rst → doc/software/testing.rst b/src/software/testing.rst → doc/software/testing.rst
diff --git a/src/software/tips.rst → doc/software/tips.rst b/src/software/tips.rst → doc/software/tips.rst
diff --git a/src/theory.rst → doc/theory.rst b/src/theory.rst → doc/theory.rst
diff --git a/src/theory/bibliography.bib → doc/theory/bibliography.bib b/src/theory/bibliography.bib → doc/theory/bibliography.bib
diff --git a/src/theory/data.rst → doc/theory/data.rst b/src/theory/data.rst → doc/theory/data.rst
diff --git a/src/theory/dynamics.ipynb → doc/theory/dynamics.ipynb b/src/theory/dynamics.ipynb → doc/theory/dynamics.ipynb
diff --git a/src/theory/formalisms.rst → doc/theory/formalisms.rst b/src/theory/formalisms.rst → doc/theory/formalisms.rst
diff --git a/src/theory/glossary.rst → doc/theory/glossary.rst b/src/theory/glossary.rst → doc/theory/glossary.rst
diff --git a/src/theory/introduction.rst → doc/theory/introduction.rst b/src/theory/introduction.rst → doc/theory/introduction.rst
diff --git a/src/theory/results.rst → doc/theory/results.rst b/src/theory/results.rst → doc/theory/results.rst
diff --git a/src/theory/topics.rst → doc/theory/topics.rst b/src/theory/topics.rst → doc/theory/topics.rst
diff --git a/src/theory/topics/cqm.rst → doc/theory/topics/cqm.rst b/src/theory/topics/cqm.rst → doc/theory/topics/cqm.rst
diff --git a/src/theory/topics/sm.rst → doc/theory/topics/sm.rst b/src/theory/topics/sm.rst → doc/theory/topics/sm.rst
diff --git a/src/theory/z.references.rst → doc/theory/z.references.rst b/src/theory/z.references.rst → doc/theory/z.references.rst
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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