v1.0.1-post1

Author: taminomara

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [unreleased]
 
+## [1.0.1-post1]
+
+- Migrated documentation to Read the Docs.
+
+- Moved repository to [sphinx-contrib](https://github.com/sphinx-contrib) organization.
+
 ## [1.0.1]
 
 - Fix parsing of inline code in Bison grammars.
@@ -16,7 +22,8 @@
 
 - Initial release.
 
-[unreleased]: https://github.com/taminomara/sphinx-syntax/compare/v1.0.1...HEAD
+[unreleased]: https://github.com/sphinx-contrib/sphinx-syntax/compare/v1.0.1-post1...HEAD
+[1.0.1-post1]: https://github.com/sphinx-contrib/sphinx-syntax/compare/v1.0.1...v1.0.1-post1
 [1.0.1]: https://github.com/taminomara/sphinx-syntax/compare/v1.0.0-post1...v1.0.1
 [1.0.0-post1]: https://github.com/taminomara/sphinx-syntax/compare/v1.0.0...v1.0.0-post1
 [1.0.0]: https://github.com/taminomara/sphinx-syntax/releases/tag/v1.0.0

CONTRIBUTING.md

@@ -2,11 +2,7 @@
 
 ## Set up your environment
 
-1. Check out the repo:
-
-   ```shell
-   git clone [email protected]:taminomara/sphinx-syntax.git
-   ```
+1. Clone the repository.
 
 2. Create a virtual environment with python `3.12` or newer.
 
@@ -45,3 +41,19 @@ Just run `sphinx` as usual, nothing special is required:
 cd docs/
 make html
 ```
+
+## Release
+
+1. Update `changelog.md`. Make sure to update links at the end of the file.
+
+   Changelog *must* have a section for the new release, otherwise the build
+   will fail.
+
+2. Push a git tag. You'll need a repository admin role to do so.
+
+   All tags should start with prefix `v`, and follow semantic versioning guidelines.
+   This, among other things, means that tags for beta-, post-, etc. releases
+   should have form `v1.0.0-beta0` instead of Python's `v1.0.0b0`.
+
+3. From here, release happens automatically. PyPi package will be uploaded from
+   CI job, and documentation will be updated by Read the Docs build.

README.md

@@ -11,9 +11,9 @@ Features:
 
 ## Resources
 
-- [Documentation](https://taminomara.github.io/sphinx-syntax/)
-- [Quickstart](https://taminomara.github.io/sphinx-syntax/quickstart)
-- [Example output](https://taminomara.github.io/sphinx-syntax/example-output)
+- [Documentation](https://sphinx-syntax.readthedocs.io/en/stable/)
+- [Quickstart](https://sphinx-syntax.readthedocs.io/en/stable/quickstart.html)
+- [Example output](https://sphinx-syntax.readthedocs.io/en/stable/example-output.html)
 
 ## Requirements
 

docs/source/conf.py

@@ -26,7 +26,7 @@
 default_role = "py:obj"
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
-    "syntax_diagrams": ("https://taminomara.github.io/syntax-diagrams", None),
+    "syntax_diagrams": ("https://syntax-diagrams.readthedocs.io/en/stable/", None),
 }
 autodoc_member_order = "bysource"
 nitpick_ignore_regex = [(r"py:class", r".*\.T")]
@@ -38,7 +38,7 @@
 html_static_path = ["_static"]
 html_extra_path = ["_extra/robots.txt"]
 html_theme_options = {
-    "source_repository": "https://github.com/taminomara/sphinx-syntax",
+    "source_repository": "https://github.com/sphinx-contribs/sphinx-syntax",
     "source_branch": "main",
     "source_directory": "docs/source",
 }

docs/source/directives.rst

@@ -186,9 +186,9 @@ Diagrams
     for the `syntax-diagrams`__ library. You can also use
     `an online diagram editor`__.
 
-    __ https://taminomara.github.io/syntax-diagrams/describe.html
+    __ https://syntax-diagrams.readthedocs.io/en/stable/describe.html
 
-    __ https://taminomara.github.io/syntax-diagrams/try
+    __ https://syntax-diagrams.readthedocs.io/en/stable/try
 
     **Example:**
 

docs/source/index.rst

@@ -38,4 +38,4 @@ Features:
     :hidden:
     :caption: Links
 
-    GitHub <https://github.com/taminomara/sphinx-syntax/>
+    GitHub <https://github.com/sphinx-contrib/sphinx-syntax/>

docs/source/quickstart.rst

@@ -103,9 +103,9 @@ using YAML__ format, its structure is detailed in documentation for the
 
 __ https://en.wikipedia.org/wiki/YAML
 
-__ https://taminomara.github.io/syntax-diagrams/describe.html
+__ https://syntax-diagrams.readthedocs.io/en/stable/describe.html
 
-__ https://taminomara.github.io/syntax-diagrams/try
+__ https://syntax-diagrams.readthedocs.io/en/stable/try
 
 .. code-block:: rst
 

pyproject.toml

@@ -56,9 +56,9 @@ doc = [
 
 [project.urls]
 Documentation = "https://sphinx-syntax.readthedocs.io/en/stable/"
-Issues = "https://github.com/taminomara/sphinx-syntax/issues"
-Source = "https://github.com/taminomara/sphinx-syntax/"
-Changelog = "https://github.com/taminomara/sphinx-syntax/blob/main/CHANGELOG.md"
+Issues = "https://github.com/sphinx-contrib/sphinx-syntax/issues"
+Source = "https://github.com/sphinx-contrib/sphinx-syntax/"
+Changelog = "https://github.com/sphinx-contrib/sphinx-syntax/blob/main/CHANGELOG.md"
 
 
 [build-system]