From 1d47ee4fd76ed004086144138615fe3485e5960e Mon Sep 17 00:00:00 2001 From: Colin Marquardt Date: Mon, 6 Nov 2023 18:54:43 +0100 Subject: [PATCH] Rename documentation/ to the more common docs/ (#3486) --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- .pre-commit-config.yaml | 2 +- .readthedocs.yml | 4 ++-- CONTRIBUTING.md | 2 +- {documentation => docs}/.gitignore | 0 {documentation => docs}/Doxyfile | 0 {documentation => docs}/README.md | 0 {documentation => docs}/_vendor/README.md | 0 .../_vendor/domaintools/LICENSE.txt | 0 .../_vendor/domaintools/MANIFEST.in | 0 .../_vendor/domaintools/README.rst | 0 .../_vendor/domaintools/setup.cfg | 0 .../_vendor/domaintools/setup.py | 0 .../_vendor/domaintools/sphinxcontrib/__init__.py | 0 .../sphinxcontrib/domaintools/__init__.py | 0 .../sphinxcontrib/domaintools/_version.py | 0 {documentation => docs}/requirements.txt | 0 .../source/_static/cocotb-logo-white.svg | 0 {documentation => docs}/source/analog_model.rst | 0 {documentation => docs}/source/building.rst | 0 {documentation => docs}/source/conf.py | 0 {documentation => docs}/source/contributors.rst | 0 {documentation => docs}/source/coroutines.rst | 0 {documentation => docs}/source/custom_flows.rst | 0 {documentation => docs}/source/diagrams/README.md | 0 .../source/diagrams/svg/cocotb_overview.svg | 0 .../source/diagrams/svg/example_regulator.svg | 0 .../source/diagrams/svg/example_rescap.svg | 0 .../source/diagrams/svg/hal_cosimulation.svg | 0 .../diagrams/svg/inheritance-cocotb.handle.svg | 0 .../source/diagrams/xml/cocotb_overview.xml | 0 .../source/diagrams/xml/example_regulator.xml | 0 .../source/diagrams/xml/example_rescap.xml | 0 .../source/diagrams/xml/hal_cosimulation.xml | 0 {documentation => docs}/source/examples.rst | 0 {documentation => docs}/source/extensions.rst | 0 .../source/further_resources.rst | 0 {documentation => docs}/source/genindex.rst | 0 {documentation => docs}/source/glossary.rst | 0 {documentation => docs}/source/index.rst | 0 {documentation => docs}/source/install.rst | 0 {documentation => docs}/source/install_devel.rst | 0 .../source/library_reference.rst | 0 .../source/library_reference_c.rst | 0 .../source/newsfragments/2255.bugfix.rst | 0 .../source/newsfragments/2731.feature.rst | 0 .../source/newsfragments/3351.feature.rst | 0 .../source/newsfragments/3354.bugfix.rst | 0 .../source/newsfragments/3409.feature.rst | 0 .../source/newsfragments/3425.removal.rst | 0 .../source/newsfragments/3427.feature.rst | 0 .../source/newsfragments/3436.change.rst | 0 .../source/newsfragments/3461.change.rst | 0 .../source/newsfragments/README.rst | 0 .../source/platform_support.rst | 0 {documentation => docs}/source/py-modindex.rst | 0 {documentation => docs}/source/quickstart.rst | 0 {documentation => docs}/source/refcard.rst | 0 {documentation => docs}/source/regulator.png | Bin {documentation => docs}/source/regulator.rst | 0 {documentation => docs}/source/release_notes.rst | 0 {documentation => docs}/source/rescap.png | Bin {documentation => docs}/source/rescap.rst | 0 {documentation => docs}/source/roadmap.rst | 0 .../source/rotating_logger.rst | 0 {documentation => docs}/source/runner.rst | 0 .../source/simulator_support.rst | 0 .../source/spelling_wordlist.txt | 0 {documentation => docs}/source/triggers.rst | 0 .../source/troubleshooting.rst | 0 .../source/writing_testbenches.rst | 0 noxfile.py | 14 ++++++-------- pyproject.toml | 4 ++-- setup.cfg | 2 +- 74 files changed, 15 insertions(+), 17 deletions(-) rename {documentation => docs}/.gitignore (100%) rename {documentation => docs}/Doxyfile (100%) rename {documentation => docs}/README.md (100%) rename {documentation => docs}/_vendor/README.md (100%) rename {documentation => docs}/_vendor/domaintools/LICENSE.txt (100%) rename {documentation => docs}/_vendor/domaintools/MANIFEST.in (100%) rename {documentation => docs}/_vendor/domaintools/README.rst (100%) rename {documentation => docs}/_vendor/domaintools/setup.cfg (100%) rename {documentation => docs}/_vendor/domaintools/setup.py (100%) rename {documentation => docs}/_vendor/domaintools/sphinxcontrib/__init__.py (100%) rename {documentation => docs}/_vendor/domaintools/sphinxcontrib/domaintools/__init__.py (100%) rename {documentation => docs}/_vendor/domaintools/sphinxcontrib/domaintools/_version.py (100%) rename {documentation => docs}/requirements.txt (100%) rename {documentation => docs}/source/_static/cocotb-logo-white.svg (100%) rename {documentation => docs}/source/analog_model.rst (100%) rename {documentation => docs}/source/building.rst (100%) rename {documentation => docs}/source/conf.py (100%) rename {documentation => docs}/source/contributors.rst (100%) rename {documentation => docs}/source/coroutines.rst (100%) rename {documentation => docs}/source/custom_flows.rst (100%) rename {documentation => docs}/source/diagrams/README.md (100%) rename {documentation => docs}/source/diagrams/svg/cocotb_overview.svg (100%) rename {documentation => docs}/source/diagrams/svg/example_regulator.svg (100%) rename {documentation => docs}/source/diagrams/svg/example_rescap.svg (100%) rename {documentation => docs}/source/diagrams/svg/hal_cosimulation.svg (100%) rename {documentation => docs}/source/diagrams/svg/inheritance-cocotb.handle.svg (100%) rename {documentation => docs}/source/diagrams/xml/cocotb_overview.xml (100%) rename {documentation => docs}/source/diagrams/xml/example_regulator.xml (100%) rename {documentation => docs}/source/diagrams/xml/example_rescap.xml (100%) rename {documentation => docs}/source/diagrams/xml/hal_cosimulation.xml (100%) rename {documentation => docs}/source/examples.rst (100%) rename {documentation => docs}/source/extensions.rst (100%) rename {documentation => docs}/source/further_resources.rst (100%) rename {documentation => docs}/source/genindex.rst (100%) rename {documentation => docs}/source/glossary.rst (100%) rename {documentation => docs}/source/index.rst (100%) rename {documentation => docs}/source/install.rst (100%) rename {documentation => docs}/source/install_devel.rst (100%) rename {documentation => docs}/source/library_reference.rst (100%) rename {documentation => docs}/source/library_reference_c.rst (100%) rename {documentation => docs}/source/newsfragments/2255.bugfix.rst (100%) rename {documentation => docs}/source/newsfragments/2731.feature.rst (100%) rename {documentation => docs}/source/newsfragments/3351.feature.rst (100%) rename {documentation => docs}/source/newsfragments/3354.bugfix.rst (100%) rename {documentation => docs}/source/newsfragments/3409.feature.rst (100%) rename {documentation => docs}/source/newsfragments/3425.removal.rst (100%) rename {documentation => docs}/source/newsfragments/3427.feature.rst (100%) rename {documentation => docs}/source/newsfragments/3436.change.rst (100%) rename {documentation => docs}/source/newsfragments/3461.change.rst (100%) rename {documentation => docs}/source/newsfragments/README.rst (100%) rename {documentation => docs}/source/platform_support.rst (100%) rename {documentation => docs}/source/py-modindex.rst (100%) rename {documentation => docs}/source/quickstart.rst (100%) rename {documentation => docs}/source/refcard.rst (100%) rename {documentation => docs}/source/regulator.png (100%) rename {documentation => docs}/source/regulator.rst (100%) rename {documentation => docs}/source/release_notes.rst (100%) rename {documentation => docs}/source/rescap.png (100%) rename {documentation => docs}/source/rescap.rst (100%) rename {documentation => docs}/source/roadmap.rst (100%) rename {documentation => docs}/source/rotating_logger.rst (100%) rename {documentation => docs}/source/runner.rst (100%) rename {documentation => docs}/source/simulator_support.rst (100%) rename {documentation => docs}/source/spelling_wordlist.txt (100%) rename {documentation => docs}/source/triggers.rst (100%) rename {documentation => docs}/source/troubleshooting.rst (100%) rename {documentation => docs}/source/writing_testbenches.rst (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ccfff224f2..23276dbff3 100644 --- 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 index f9fef04279..921701e62a 100644 --- 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 index 8fc6928973..af2d3b0a88 100644 --- 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 index 1c9543631f..32e4bc68ea 100644 --- 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 b/docs/.gitignore similarity index 100% rename from documentation/.gitignore rename to docs/.gitignore diff --git a/documentation/Doxyfile b/docs/Doxyfile similarity index 100% rename from documentation/Doxyfile rename to docs/Doxyfile diff --git a/documentation/README.md b/docs/README.md similarity index 100% rename from documentation/README.md rename to docs/README.md diff --git a/documentation/_vendor/README.md b/docs/_vendor/README.md similarity index 100% rename from documentation/_vendor/README.md rename to docs/_vendor/README.md diff --git a/documentation/_vendor/domaintools/LICENSE.txt b/docs/_vendor/domaintools/LICENSE.txt similarity index 100% rename from documentation/_vendor/domaintools/LICENSE.txt rename to docs/_vendor/domaintools/LICENSE.txt diff --git a/documentation/_vendor/domaintools/MANIFEST.in b/docs/_vendor/domaintools/MANIFEST.in similarity index 100% rename from documentation/_vendor/domaintools/MANIFEST.in rename to docs/_vendor/domaintools/MANIFEST.in diff --git a/documentation/_vendor/domaintools/README.rst b/docs/_vendor/domaintools/README.rst similarity index 100% rename from documentation/_vendor/domaintools/README.rst rename to docs/_vendor/domaintools/README.rst diff --git a/documentation/_vendor/domaintools/setup.cfg b/docs/_vendor/domaintools/setup.cfg similarity index 100% rename from documentation/_vendor/domaintools/setup.cfg rename to docs/_vendor/domaintools/setup.cfg diff --git a/documentation/_vendor/domaintools/setup.py b/docs/_vendor/domaintools/setup.py similarity index 100% rename from documentation/_vendor/domaintools/setup.py rename to docs/_vendor/domaintools/setup.py diff --git a/documentation/_vendor/domaintools/sphinxcontrib/__init__.py b/docs/_vendor/domaintools/sphinxcontrib/__init__.py similarity index 100% rename from documentation/_vendor/domaintools/sphinxcontrib/__init__.py rename to docs/_vendor/domaintools/sphinxcontrib/__init__.py diff --git a/documentation/_vendor/domaintools/sphinxcontrib/domaintools/__init__.py b/docs/_vendor/domaintools/sphinxcontrib/domaintools/__init__.py similarity index 100% rename from documentation/_vendor/domaintools/sphinxcontrib/domaintools/__init__.py rename to docs/_vendor/domaintools/sphinxcontrib/domaintools/__init__.py diff --git a/documentation/_vendor/domaintools/sphinxcontrib/domaintools/_version.py b/docs/_vendor/domaintools/sphinxcontrib/domaintools/_version.py similarity index 100% rename from documentation/_vendor/domaintools/sphinxcontrib/domaintools/_version.py rename to docs/_vendor/domaintools/sphinxcontrib/domaintools/_version.py diff --git a/documentation/requirements.txt b/docs/requirements.txt similarity index 100% rename from documentation/requirements.txt rename to docs/requirements.txt diff --git a/documentation/source/_static/cocotb-logo-white.svg b/docs/source/_static/cocotb-logo-white.svg similarity index 100% rename from documentation/source/_static/cocotb-logo-white.svg rename to docs/source/_static/cocotb-logo-white.svg diff --git a/documentation/source/analog_model.rst b/docs/source/analog_model.rst similarity index 100% rename from documentation/source/analog_model.rst rename to docs/source/analog_model.rst diff --git a/documentation/source/building.rst b/docs/source/building.rst similarity index 100% rename from documentation/source/building.rst rename to docs/source/building.rst diff --git a/documentation/source/conf.py b/docs/source/conf.py similarity index 100% rename from documentation/source/conf.py rename to docs/source/conf.py diff --git a/documentation/source/contributors.rst b/docs/source/contributors.rst similarity index 100% rename from documentation/source/contributors.rst rename to docs/source/contributors.rst diff --git a/documentation/source/coroutines.rst b/docs/source/coroutines.rst similarity index 100% rename from documentation/source/coroutines.rst rename to docs/source/coroutines.rst diff --git a/documentation/source/custom_flows.rst b/docs/source/custom_flows.rst similarity index 100% rename from documentation/source/custom_flows.rst rename to docs/source/custom_flows.rst diff --git a/documentation/source/diagrams/README.md b/docs/source/diagrams/README.md similarity index 100% rename from documentation/source/diagrams/README.md rename to docs/source/diagrams/README.md diff --git a/documentation/source/diagrams/svg/cocotb_overview.svg b/docs/source/diagrams/svg/cocotb_overview.svg similarity index 100% rename from documentation/source/diagrams/svg/cocotb_overview.svg rename to docs/source/diagrams/svg/cocotb_overview.svg diff --git a/documentation/source/diagrams/svg/example_regulator.svg b/docs/source/diagrams/svg/example_regulator.svg similarity index 100% rename from documentation/source/diagrams/svg/example_regulator.svg rename to docs/source/diagrams/svg/example_regulator.svg diff --git a/documentation/source/diagrams/svg/example_rescap.svg b/docs/source/diagrams/svg/example_rescap.svg similarity index 100% rename from documentation/source/diagrams/svg/example_rescap.svg rename to docs/source/diagrams/svg/example_rescap.svg diff --git a/documentation/source/diagrams/svg/hal_cosimulation.svg b/docs/source/diagrams/svg/hal_cosimulation.svg similarity index 100% rename from documentation/source/diagrams/svg/hal_cosimulation.svg rename to docs/source/diagrams/svg/hal_cosimulation.svg diff --git a/documentation/source/diagrams/svg/inheritance-cocotb.handle.svg b/docs/source/diagrams/svg/inheritance-cocotb.handle.svg similarity index 100% rename from documentation/source/diagrams/svg/inheritance-cocotb.handle.svg rename to docs/source/diagrams/svg/inheritance-cocotb.handle.svg diff --git a/documentation/source/diagrams/xml/cocotb_overview.xml b/docs/source/diagrams/xml/cocotb_overview.xml similarity index 100% rename from documentation/source/diagrams/xml/cocotb_overview.xml rename to docs/source/diagrams/xml/cocotb_overview.xml diff --git a/documentation/source/diagrams/xml/example_regulator.xml b/docs/source/diagrams/xml/example_regulator.xml similarity index 100% rename from documentation/source/diagrams/xml/example_regulator.xml rename to docs/source/diagrams/xml/example_regulator.xml diff --git a/documentation/source/diagrams/xml/example_rescap.xml b/docs/source/diagrams/xml/example_rescap.xml similarity index 100% rename from documentation/source/diagrams/xml/example_rescap.xml rename to docs/source/diagrams/xml/example_rescap.xml diff --git a/documentation/source/diagrams/xml/hal_cosimulation.xml b/docs/source/diagrams/xml/hal_cosimulation.xml similarity index 100% rename from documentation/source/diagrams/xml/hal_cosimulation.xml rename to docs/source/diagrams/xml/hal_cosimulation.xml diff --git a/documentation/source/examples.rst b/docs/source/examples.rst similarity index 100% rename from documentation/source/examples.rst rename to docs/source/examples.rst diff --git a/documentation/source/extensions.rst b/docs/source/extensions.rst similarity index 100% rename from documentation/source/extensions.rst rename to docs/source/extensions.rst diff --git a/documentation/source/further_resources.rst b/docs/source/further_resources.rst similarity index 100% rename from documentation/source/further_resources.rst rename to docs/source/further_resources.rst diff --git a/documentation/source/genindex.rst b/docs/source/genindex.rst similarity index 100% rename from documentation/source/genindex.rst rename to docs/source/genindex.rst diff --git a/documentation/source/glossary.rst b/docs/source/glossary.rst similarity index 100% rename from documentation/source/glossary.rst rename to docs/source/glossary.rst diff --git a/documentation/source/index.rst b/docs/source/index.rst similarity index 100% rename from documentation/source/index.rst rename to docs/source/index.rst diff --git a/documentation/source/install.rst b/docs/source/install.rst similarity index 100% rename from documentation/source/install.rst rename to docs/source/install.rst diff --git a/documentation/source/install_devel.rst b/docs/source/install_devel.rst similarity index 100% rename from documentation/source/install_devel.rst rename to docs/source/install_devel.rst diff --git a/documentation/source/library_reference.rst b/docs/source/library_reference.rst similarity index 100% rename from documentation/source/library_reference.rst rename to docs/source/library_reference.rst diff --git a/documentation/source/library_reference_c.rst b/docs/source/library_reference_c.rst similarity index 100% rename from documentation/source/library_reference_c.rst rename to docs/source/library_reference_c.rst diff --git a/documentation/source/newsfragments/2255.bugfix.rst b/docs/source/newsfragments/2255.bugfix.rst similarity index 100% rename from documentation/source/newsfragments/2255.bugfix.rst rename to docs/source/newsfragments/2255.bugfix.rst diff --git a/documentation/source/newsfragments/2731.feature.rst b/docs/source/newsfragments/2731.feature.rst similarity index 100% rename from documentation/source/newsfragments/2731.feature.rst rename to docs/source/newsfragments/2731.feature.rst diff --git a/documentation/source/newsfragments/3351.feature.rst b/docs/source/newsfragments/3351.feature.rst similarity index 100% rename from documentation/source/newsfragments/3351.feature.rst rename to docs/source/newsfragments/3351.feature.rst diff --git a/documentation/source/newsfragments/3354.bugfix.rst b/docs/source/newsfragments/3354.bugfix.rst similarity index 100% rename from documentation/source/newsfragments/3354.bugfix.rst rename to docs/source/newsfragments/3354.bugfix.rst diff --git a/documentation/source/newsfragments/3409.feature.rst b/docs/source/newsfragments/3409.feature.rst similarity index 100% rename from documentation/source/newsfragments/3409.feature.rst rename to docs/source/newsfragments/3409.feature.rst diff --git a/documentation/source/newsfragments/3425.removal.rst b/docs/source/newsfragments/3425.removal.rst similarity index 100% rename from documentation/source/newsfragments/3425.removal.rst rename to docs/source/newsfragments/3425.removal.rst diff --git a/documentation/source/newsfragments/3427.feature.rst b/docs/source/newsfragments/3427.feature.rst similarity index 100% rename from documentation/source/newsfragments/3427.feature.rst rename to docs/source/newsfragments/3427.feature.rst diff --git a/documentation/source/newsfragments/3436.change.rst b/docs/source/newsfragments/3436.change.rst similarity index 100% rename from documentation/source/newsfragments/3436.change.rst rename to docs/source/newsfragments/3436.change.rst diff --git a/documentation/source/newsfragments/3461.change.rst b/docs/source/newsfragments/3461.change.rst similarity index 100% rename from documentation/source/newsfragments/3461.change.rst rename to docs/source/newsfragments/3461.change.rst diff --git a/documentation/source/newsfragments/README.rst b/docs/source/newsfragments/README.rst similarity index 100% rename from documentation/source/newsfragments/README.rst rename to docs/source/newsfragments/README.rst diff --git a/documentation/source/platform_support.rst b/docs/source/platform_support.rst similarity index 100% rename from documentation/source/platform_support.rst rename to docs/source/platform_support.rst diff --git a/documentation/source/py-modindex.rst b/docs/source/py-modindex.rst similarity index 100% rename from documentation/source/py-modindex.rst rename to docs/source/py-modindex.rst diff --git a/documentation/source/quickstart.rst b/docs/source/quickstart.rst similarity index 100% rename from documentation/source/quickstart.rst rename to docs/source/quickstart.rst diff --git a/documentation/source/refcard.rst b/docs/source/refcard.rst similarity index 100% rename from documentation/source/refcard.rst rename to docs/source/refcard.rst diff --git a/documentation/source/regulator.png b/docs/source/regulator.png similarity index 100% rename from documentation/source/regulator.png rename to docs/source/regulator.png diff --git a/documentation/source/regulator.rst b/docs/source/regulator.rst similarity index 100% rename from documentation/source/regulator.rst rename to docs/source/regulator.rst diff --git a/documentation/source/release_notes.rst b/docs/source/release_notes.rst similarity index 100% rename from documentation/source/release_notes.rst rename to docs/source/release_notes.rst diff --git a/documentation/source/rescap.png b/docs/source/rescap.png similarity index 100% rename from documentation/source/rescap.png rename to docs/source/rescap.png diff --git a/documentation/source/rescap.rst b/docs/source/rescap.rst similarity index 100% rename from documentation/source/rescap.rst rename to docs/source/rescap.rst diff --git a/documentation/source/roadmap.rst b/docs/source/roadmap.rst similarity index 100% rename from documentation/source/roadmap.rst rename to docs/source/roadmap.rst diff --git a/documentation/source/rotating_logger.rst b/docs/source/rotating_logger.rst similarity index 100% rename from documentation/source/rotating_logger.rst rename to docs/source/rotating_logger.rst diff --git a/documentation/source/runner.rst b/docs/source/runner.rst similarity index 100% rename from documentation/source/runner.rst rename to docs/source/runner.rst diff --git a/documentation/source/simulator_support.rst b/docs/source/simulator_support.rst similarity index 100% rename from documentation/source/simulator_support.rst rename to docs/source/simulator_support.rst diff --git a/documentation/source/spelling_wordlist.txt b/docs/source/spelling_wordlist.txt similarity index 100% rename from documentation/source/spelling_wordlist.txt rename to docs/source/spelling_wordlist.txt diff --git a/documentation/source/triggers.rst b/docs/source/triggers.rst similarity index 100% rename from documentation/source/triggers.rst rename to docs/source/triggers.rst diff --git a/documentation/source/troubleshooting.rst b/docs/source/troubleshooting.rst similarity index 100% rename from documentation/source/troubleshooting.rst rename to docs/source/troubleshooting.rst diff --git a/documentation/source/writing_testbenches.rst b/docs/source/writing_testbenches.rst similarity index 100% rename from documentation/source/writing_testbenches.rst rename to docs/source/writing_testbenches.rst diff --git a/noxfile.py b/noxfile.py index 30a7d323ef..53789425d2 100644 --- 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 index d9d10917d4..a29c3ff012 100644 --- 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 index f10a4bfac1..ffa0b4d9e8 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [flake8] extend-exclude = - documentation/source/conf.py, + docs/source/conf.py, makefiles, venv, _vendor,