Rename documentation/ to the more common docs/ (cocotb#3486)

cmarqu · Nov 6, 2023 · 1d47ee4 · 1d47ee4
1 parent d9f8133
commit 1d47ee4
Show file tree

Hide file tree

Showing 74 changed files with 15 additions and 17 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -7,10 +7,10 @@ Most important: please explain *why* you are proposing this change.
 
 * Make sure you have read https://github.com/cocotb/cocotb/blob/master/CONTRIBUTING.md
 * Extend or add a test under `tests/test_cases/`.
-* Add documentation under `documentation/source/`,
+* Add documentation under `docs/source/`,
   docstrings in Python code, or Doxygen markup in C/C++ code.
   Use ``versionadded``/``versionchanged``/``deprecated``.
-* Add a newsfragment - see `documentation/source/newsfragments/README.rst`.
+* Add a newsfragment - see `docs/source/newsfragments/README.rst`.
 * Use `closes #XXXX` to auto-close the issue that this PR fixes (if such).
 
 -->
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -35,4 +35,4 @@ repos:
     args:
     - "--fix=lf"
   - id: "end-of-file-fixer"
-    exclude: "^documentation/source/diagrams/(svg|xml)/"
+    exclude: "^docs/source/diagrams/(svg|xml)/"
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -13,11 +13,11 @@ build:
 
 python:
   install:
-    - requirements: documentation/requirements.txt
+    - requirements: docs/requirements.txt
     - method: pip
       path: .
       extra_requirements:
         - bus
 
 sphinx:
-  configuration: documentation/source/conf.py
+  configuration: docs/source/conf.py
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -410,7 +410,7 @@ All changes which should go into the main codebase of cocotb must follow this se
 - All code must pass existing tests.
   New functionality must be accompanied by tests, and bug fixes should add tests to increase the test coverage and prevent regressions.
 - If code changes or enhances documented behavior the documentation should be updated.
-- If a change is user-visible, a newsfragment should be added to `documentation/source/newsfragments`.
+- If a change is user-visible, a newsfragment should be added to `docs/source/newsfragments`.
 - All pull requests must be accepted by at least one maintainer, with no maintainer strongly objecting.
   Reviews must be performed by a person other than the primary author of the code.
 - All commits should follow established best practices when creating a commit message:

diff --git a/documentation/.gitignore → docs/.gitignore b/documentation/.gitignore → docs/.gitignore
diff --git a/documentation/Doxyfile → docs/Doxyfile b/documentation/Doxyfile → docs/Doxyfile
diff --git a/documentation/README.md → docs/README.md b/documentation/README.md → docs/README.md
diff --git a/documentation/_vendor/README.md → docs/_vendor/README.md b/documentation/_vendor/README.md → docs/_vendor/README.md
diff --git a/...mentation/_vendor/domaintools/LICENSE.txt → docs/_vendor/domaintools/LICENSE.txt b/...mentation/_vendor/domaintools/LICENSE.txt → docs/_vendor/domaintools/LICENSE.txt
diff --git a/...mentation/_vendor/domaintools/MANIFEST.in → docs/_vendor/domaintools/MANIFEST.in b/...mentation/_vendor/domaintools/MANIFEST.in → docs/_vendor/domaintools/MANIFEST.in
diff --git a/documentation/_vendor/domaintools/README.rst → docs/_vendor/domaintools/README.rst b/documentation/_vendor/domaintools/README.rst → docs/_vendor/domaintools/README.rst
diff --git a/documentation/_vendor/domaintools/setup.cfg → docs/_vendor/domaintools/setup.cfg b/documentation/_vendor/domaintools/setup.cfg → docs/_vendor/domaintools/setup.cfg
diff --git a/documentation/_vendor/domaintools/setup.py → docs/_vendor/domaintools/setup.py b/documentation/_vendor/domaintools/setup.py → docs/_vendor/domaintools/setup.py
diff --git a/...dor/domaintools/sphinxcontrib/__init__.py → ...dor/domaintools/sphinxcontrib/__init__.py b/...dor/domaintools/sphinxcontrib/__init__.py → ...dor/domaintools/sphinxcontrib/__init__.py
diff --git a/...ols/sphinxcontrib/domaintools/__init__.py → ...ols/sphinxcontrib/domaintools/__init__.py b/...ols/sphinxcontrib/domaintools/__init__.py → ...ols/sphinxcontrib/domaintools/__init__.py
diff --git a/...ols/sphinxcontrib/domaintools/_version.py → ...ols/sphinxcontrib/domaintools/_version.py b/...ols/sphinxcontrib/domaintools/_version.py → ...ols/sphinxcontrib/domaintools/_version.py
diff --git a/documentation/requirements.txt → docs/requirements.txt b/documentation/requirements.txt → docs/requirements.txt
diff --git a/...tion/source/_static/cocotb-logo-white.svg → docs/source/_static/cocotb-logo-white.svg b/...tion/source/_static/cocotb-logo-white.svg → docs/source/_static/cocotb-logo-white.svg
diff --git a/documentation/source/analog_model.rst → docs/source/analog_model.rst b/documentation/source/analog_model.rst → docs/source/analog_model.rst
diff --git a/documentation/source/building.rst → docs/source/building.rst b/documentation/source/building.rst → docs/source/building.rst
diff --git a/documentation/source/conf.py → docs/source/conf.py b/documentation/source/conf.py → docs/source/conf.py
diff --git a/documentation/source/contributors.rst → docs/source/contributors.rst b/documentation/source/contributors.rst → docs/source/contributors.rst
diff --git a/documentation/source/coroutines.rst → docs/source/coroutines.rst b/documentation/source/coroutines.rst → docs/source/coroutines.rst
diff --git a/documentation/source/custom_flows.rst → docs/source/custom_flows.rst b/documentation/source/custom_flows.rst → docs/source/custom_flows.rst
diff --git a/documentation/source/diagrams/README.md → docs/source/diagrams/README.md b/documentation/source/diagrams/README.md → docs/source/diagrams/README.md
diff --git a/...n/source/diagrams/svg/cocotb_overview.svg → docs/source/diagrams/svg/cocotb_overview.svg b/...n/source/diagrams/svg/cocotb_overview.svg → docs/source/diagrams/svg/cocotb_overview.svg
diff --git a/...source/diagrams/svg/example_regulator.svg → ...source/diagrams/svg/example_regulator.svg b/...source/diagrams/svg/example_regulator.svg → ...source/diagrams/svg/example_regulator.svg
diff --git a/...on/source/diagrams/svg/example_rescap.svg → docs/source/diagrams/svg/example_rescap.svg b/...on/source/diagrams/svg/example_rescap.svg → docs/source/diagrams/svg/example_rescap.svg
diff --git a/.../source/diagrams/svg/hal_cosimulation.svg → .../source/diagrams/svg/hal_cosimulation.svg b/.../source/diagrams/svg/hal_cosimulation.svg → .../source/diagrams/svg/hal_cosimulation.svg
diff --git a/...iagrams/svg/inheritance-cocotb.handle.svg → ...iagrams/svg/inheritance-cocotb.handle.svg b/...iagrams/svg/inheritance-cocotb.handle.svg → ...iagrams/svg/inheritance-cocotb.handle.svg
diff --git a/...n/source/diagrams/xml/cocotb_overview.xml → docs/source/diagrams/xml/cocotb_overview.xml b/...n/source/diagrams/xml/cocotb_overview.xml → docs/source/diagrams/xml/cocotb_overview.xml
diff --git a/...source/diagrams/xml/example_regulator.xml → ...source/diagrams/xml/example_regulator.xml b/...source/diagrams/xml/example_regulator.xml → ...source/diagrams/xml/example_regulator.xml
diff --git a/...on/source/diagrams/xml/example_rescap.xml → docs/source/diagrams/xml/example_rescap.xml b/...on/source/diagrams/xml/example_rescap.xml → docs/source/diagrams/xml/example_rescap.xml
diff --git a/.../source/diagrams/xml/hal_cosimulation.xml → .../source/diagrams/xml/hal_cosimulation.xml b/.../source/diagrams/xml/hal_cosimulation.xml → .../source/diagrams/xml/hal_cosimulation.xml
diff --git a/documentation/source/examples.rst → docs/source/examples.rst b/documentation/source/examples.rst → docs/source/examples.rst
diff --git a/documentation/source/extensions.rst → docs/source/extensions.rst b/documentation/source/extensions.rst → docs/source/extensions.rst
diff --git a/documentation/source/further_resources.rst → docs/source/further_resources.rst b/documentation/source/further_resources.rst → docs/source/further_resources.rst
diff --git a/documentation/source/genindex.rst → docs/source/genindex.rst b/documentation/source/genindex.rst → docs/source/genindex.rst
diff --git a/documentation/source/glossary.rst → docs/source/glossary.rst b/documentation/source/glossary.rst → docs/source/glossary.rst
diff --git a/documentation/source/index.rst → docs/source/index.rst b/documentation/source/index.rst → docs/source/index.rst
diff --git a/documentation/source/install.rst → docs/source/install.rst b/documentation/source/install.rst → docs/source/install.rst
diff --git a/documentation/source/install_devel.rst → docs/source/install_devel.rst b/documentation/source/install_devel.rst → docs/source/install_devel.rst
diff --git a/documentation/source/library_reference.rst → docs/source/library_reference.rst b/documentation/source/library_reference.rst → docs/source/library_reference.rst
diff --git a/documentation/source/library_reference_c.rst → docs/source/library_reference_c.rst b/documentation/source/library_reference_c.rst → docs/source/library_reference_c.rst
diff --git a/...tion/source/newsfragments/2255.bugfix.rst → docs/source/newsfragments/2255.bugfix.rst b/...tion/source/newsfragments/2255.bugfix.rst → docs/source/newsfragments/2255.bugfix.rst
diff --git a/...ion/source/newsfragments/2731.feature.rst → docs/source/newsfragments/2731.feature.rst b/...ion/source/newsfragments/2731.feature.rst → docs/source/newsfragments/2731.feature.rst
diff --git a/...ion/source/newsfragments/3351.feature.rst → docs/source/newsfragments/3351.feature.rst b/...ion/source/newsfragments/3351.feature.rst → docs/source/newsfragments/3351.feature.rst
diff --git a/...tion/source/newsfragments/3354.bugfix.rst → docs/source/newsfragments/3354.bugfix.rst b/...tion/source/newsfragments/3354.bugfix.rst → docs/source/newsfragments/3354.bugfix.rst
diff --git a/...ion/source/newsfragments/3409.feature.rst → docs/source/newsfragments/3409.feature.rst b/...ion/source/newsfragments/3409.feature.rst → docs/source/newsfragments/3409.feature.rst
diff --git a/...ion/source/newsfragments/3425.removal.rst → docs/source/newsfragments/3425.removal.rst b/...ion/source/newsfragments/3425.removal.rst → docs/source/newsfragments/3425.removal.rst
diff --git a/...ion/source/newsfragments/3427.feature.rst → docs/source/newsfragments/3427.feature.rst b/...ion/source/newsfragments/3427.feature.rst → docs/source/newsfragments/3427.feature.rst
diff --git a/...tion/source/newsfragments/3436.change.rst → docs/source/newsfragments/3436.change.rst b/...tion/source/newsfragments/3436.change.rst → docs/source/newsfragments/3436.change.rst
diff --git a/...tion/source/newsfragments/3461.change.rst → docs/source/newsfragments/3461.change.rst b/...tion/source/newsfragments/3461.change.rst → docs/source/newsfragments/3461.change.rst
diff --git a/...mentation/source/newsfragments/README.rst → docs/source/newsfragments/README.rst b/...mentation/source/newsfragments/README.rst → docs/source/newsfragments/README.rst
diff --git a/documentation/source/platform_support.rst → docs/source/platform_support.rst b/documentation/source/platform_support.rst → docs/source/platform_support.rst
diff --git a/documentation/source/py-modindex.rst → docs/source/py-modindex.rst b/documentation/source/py-modindex.rst → docs/source/py-modindex.rst
diff --git a/documentation/source/quickstart.rst → docs/source/quickstart.rst b/documentation/source/quickstart.rst → docs/source/quickstart.rst
diff --git a/documentation/source/refcard.rst → docs/source/refcard.rst b/documentation/source/refcard.rst → docs/source/refcard.rst
diff --git a/documentation/source/regulator.png → docs/source/regulator.png b/documentation/source/regulator.png → docs/source/regulator.png
diff --git a/documentation/source/regulator.rst → docs/source/regulator.rst b/documentation/source/regulator.rst → docs/source/regulator.rst
diff --git a/documentation/source/release_notes.rst → docs/source/release_notes.rst b/documentation/source/release_notes.rst → docs/source/release_notes.rst
diff --git a/documentation/source/rescap.png → docs/source/rescap.png b/documentation/source/rescap.png → docs/source/rescap.png
diff --git a/documentation/source/rescap.rst → docs/source/rescap.rst b/documentation/source/rescap.rst → docs/source/rescap.rst
diff --git a/documentation/source/roadmap.rst → docs/source/roadmap.rst b/documentation/source/roadmap.rst → docs/source/roadmap.rst
diff --git a/documentation/source/rotating_logger.rst → docs/source/rotating_logger.rst b/documentation/source/rotating_logger.rst → docs/source/rotating_logger.rst
diff --git a/documentation/source/runner.rst → docs/source/runner.rst b/documentation/source/runner.rst → docs/source/runner.rst
diff --git a/documentation/source/simulator_support.rst → docs/source/simulator_support.rst b/documentation/source/simulator_support.rst → docs/source/simulator_support.rst
diff --git a/documentation/source/spelling_wordlist.txt → docs/source/spelling_wordlist.txt b/documentation/source/spelling_wordlist.txt → docs/source/spelling_wordlist.txt
diff --git a/documentation/source/triggers.rst → docs/source/triggers.rst b/documentation/source/triggers.rst → docs/source/triggers.rst
diff --git a/documentation/source/troubleshooting.rst → docs/source/troubleshooting.rst b/documentation/source/troubleshooting.rst → docs/source/troubleshooting.rst
diff --git a/documentation/source/writing_testbenches.rst → docs/source/writing_testbenches.rst b/documentation/source/writing_testbenches.rst → docs/source/writing_testbenches.rst
diff --git a/noxfile.py b/noxfile.py
@@ -524,9 +524,9 @@ def release_test_nosim(session: nox.Session) -> None:
 
 def create_env_for_docs_build(session: nox.Session) -> None:
     session.run(
-        "pip", "install", "documentation/_vendor/domaintools"
+        "pip", "install", "docs/_vendor/domaintools"
     )  # not done in requirements.txt due to the way relative paths are handled in that file (gh-pypa/pip#8765)
-    session.run("pip", "install", "-r", "documentation/requirements.txt")
+    session.run("pip", "install", "-r", "docs/requirements.txt")
     session.run("pip", "install", "-e", ".")
 
 
@@ -535,9 +535,7 @@ def docs(session: nox.Session) -> None:
     """invoke sphinx-build to build the HTML docs"""
     create_env_for_docs_build(session)
     outdir = session.cache_dir / "docs_out"
-    session.run(
-        "sphinx-build", "./documentation/source", str(outdir), "--color", "-b", "html"
-    )
+    session.run("sphinx-build", "./docs/source", str(outdir), "--color", "-b", "html")
     index = (outdir / "index.html").resolve().as_uri()
     session.log(f"Documentation is available at {index}")
 
@@ -559,7 +557,7 @@ def docs_preview(session: nox.Session) -> None:
         # changes to cocotb code.
         "--watch",
         "cocotb",
-        "./documentation/source",
+        "./docs/source",
         str(outdir),
     )
 
@@ -571,7 +569,7 @@ def docs_linkcheck(session: nox.Session) -> None:
     outdir = session.cache_dir / "docs_out"
     session.run(
         "sphinx-build",
-        "./documentation/source",
+        "./docs/source",
         str(outdir),
         "--color",
         "-b",
@@ -586,7 +584,7 @@ def docs_spelling(session: nox.Session) -> None:
     outdir = session.cache_dir / "docs_out"
     session.run(
         "sphinx-build",
-        "./documentation/source",
+        "./docs/source",
         str(outdir),
         "--color",
         "-b",

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [tool.towncrier]
     package = "cocotb"
-    directory = "documentation/source/newsfragments"
-    filename = "documentation/source/release_notes.rst"
+    directory = "docs/source/newsfragments"
+    filename = "docs/source/release_notes.rst"
     issue_format = ":pr:`{issue}`"
     # The first underline is used for the version/date header,
     # the second underline for the subcategories (like 'Features')

diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [flake8]
 extend-exclude =
-    documentation/source/conf.py,
+    docs/source/conf.py,
     makefiles,
     venv,
     _vendor,