diff --git a/.flake8 b/.flake8 similarity index 94% rename from .flake8 rename to .flake8 index a80b07f..f3fced6 100644 --- a/.flake8 +++ b/.flake8 @@ -6,7 +6,7 @@ exclude = __pycache__, build, dist, - doc/source/conf.py + docs/source/conf.py max-line-length = 79 # Ignore some style 'errors' produced while formatting by 'black' # https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#labels-why-pycodestyle-warnings diff --git a/.github/workflows/_publish-docs-on-release.yml b/.github/workflows/_publish-docs-on-release.yml index 6481285..7cd3aa7 100644 --- a/.github/workflows/_publish-docs-on-release.yml +++ b/.github/workflows/_publish-docs-on-release.yml @@ -70,10 +70,10 @@ jobs: Xvfb :99 -screen 0 1024x768x16 & - name: build documents - run: make -C doc html + run: make -C docs html - name: Deploy uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./doc/build/html + publish_dir: ./docs/build/html diff --git a/news/doc-to-docs.rst b/news/doc-to-docs.rst new file mode 100644 index 0000000..291301e --- /dev/null +++ b/news/doc-to-docs.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* Rename all mentions of `doc` to `docs`. + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*