v3.5.0-post1

Author: taminomara

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [unreleased]
 
+## [3.5.0-post1]
+
+- Migrated documentation to Read the Docs.
+
+- Moved repository to [sphinx-contrib](https://github.com/sphinx-contrib) organization.
+
 ## [3.5.0]
 
 - Added `autodata`, `autoattribute`, `autoclass`, and other `auto*` directives.
@@ -53,7 +59,7 @@
 - Added a warning for situations when `lua_ls_project_directories` contains directories
   outside of the current VCS root.
 
-[#19]: https://github.com/taminomara/sphinx-lua-ls/pull/19
+[#19]: https://github.com/sphinx-contrib/lua-ls/pull/19
 
 ## [3.2.0]
 
@@ -65,7 +71,7 @@
 
 - Done some internal refactorings.
 
-[#18]: https://github.com/taminomara/sphinx-lua-ls/pull/18
+[#18]: https://github.com/sphinx-contrib/lua-ls/pull/18
 [@bkoropoff]: https://github.com/bkoropoff
 
 ## [3.1.0]
@@ -147,7 +153,7 @@
 - Added option to separate module members into their own files for `apidoc`.
 
 [EmmyLua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
-[#3]: https://github.com/taminomara/sphinx-lua-ls/issues/3
+[#3]: https://github.com/sphinx-contrib/lua-ls/issues/3
 
 ### Migrating to 3.0.0
 
@@ -215,14 +221,15 @@ use `!doctype table` instead, otherwise you'll get errors that modules are not a
 
 Initial release.
 
-[unreleased]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.5.0...HEAD
-[3.5.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.4.0...v3.5.0
-[3.4.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.3.0...v3.4.0
-[3.3.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.2.0...v3.3.0
-[3.2.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.1.0...v3.2.0
-[3.1.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.0.0...v3.1.0
-[3.0.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v2.0.1...v3.0.0
-[2.0.1]: https://github.com/taminomara/sphinx-lua-ls/compare/v2.0.0...v2.0.1
-[2.0.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v1.1.0...v2.0.0
-[1.1.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v1.0.0...v1.1.0
-[1.0.0]: https://github.com/taminomara/sphinx-lua-ls/releases/tag/v1.0.0
+[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0-post1...HEAD
+[3.5.0-post1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0...v3.5.0-post1
+[3.5.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.4.0...v3.5.0
+[3.4.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.3.0...v3.4.0
+[3.3.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.2.0...v3.3.0
+[3.2.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.1.0...v3.2.0
+[3.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.0.0...v3.1.0
+[3.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.1...v3.0.0
+[2.0.1]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v1.1.0...v2.0.0
+[1.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/sphinx-contrib/lua-ls/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-lua-ls.git
-   ```
+1. Clone the repository.
 
 2. Create a virtual environment with python `3.12` or newer.
 
@@ -58,3 +54,20 @@ make html
 ```
 
 Sphinx-LuaLs will download the latest version of Lua Language Server for you.
+
+
+## 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

@@ -7,10 +7,10 @@ Document Lua projects using Lua Language Server's output. This plugin features:
 
 ## Resources
 
-- [Documentation](https://taminomara.github.io/sphinx-lua-ls/)
-- [Installation](https://taminomara.github.io/sphinx-lua-ls/installation.html)
-- [Quickstart](https://taminomara.github.io/sphinx-lua-ls/quickstart.html)
-- [Example output](https://taminomara.github.io/sphinx-lua-ls/example.html)
+- [Documentation](https://sphinx-lua-ls.readthedocs.io/en/stable/)
+- [Installation](https://sphinx-lua-ls.readthedocs.io/en/stable/installation.html)
+- [Quickstart](https://sphinx-lua-ls.readthedocs.io/en/stable/quickstart.html)
+- [Example output](https://sphinx-lua-ls.readthedocs.io/en/stable/example.html)
 
 ## Requirements
 

docs/source/conf.py

@@ -38,7 +38,7 @@
 html_theme = "furo"
 html_extra_path = ["_extra/robots.txt"]
 html_theme_options = {
-    "source_repository": "https://github.com/taminomara/sphinx-lua-ls",
+    "source_repository": "https://github.com/sphinx-contrib/lua-ls",
     "source_branch": "main",
     "source_directory": "docs/source",
 }

docs/source/index.rst

@@ -26,4 +26,4 @@ See an example output: `logging`.
     :hidden:
     :caption: Links
 
-    GitHub <https://github.com/taminomara/sphinx-lua-ls/>
+    GitHub <https://github.com/sphinx-contrib/lua-ls/>

pyproject.toml

@@ -55,10 +55,10 @@ doc = [
 ]
 
 [project.urls]
-Documentation = "https://taminomara.github.io/sphinx-lua-ls/"
-Issues = "https://github.com/taminomara/sphinx-lua-ls/issues"
-Source = "https://github.com/taminomara/sphinx-lua-ls/"
-Changelog = "https://github.com/taminomara/sphinx-lua-ls/blob/main/CHANGELOG.md"
+Documentation = "https://sphinx-lua-ls.readthedocs.io/en/stable/"
+Issues = "https://github.com/sphinx-contrib/lua-ls/issues"
+Source = "https://github.com/sphinx-contrib/lua-ls/"
+Changelog = "https://github.com/sphinx-contrib/lua-ls/blob/main/CHANGELOG.md"
 
 [build-system]
 requires = ["setuptools>=60", "setuptools_scm[toml]>=8", "wheel>=0.40"]

sphinx_lua_ls/apidoc.py

@@ -109,7 +109,7 @@ def generate(
         msg = (
             "Running Lua apidoc on case-insensitive file system."
             "\nIf you experience issues, see documentation for potential solutions:"
-            "\n    https://taminomara.github.io/sphinx-lua-ls/settings.html#lua_ls_apidoc_separate_members"
+            "\n    https://sphinx-lua-ls.readthedocs.io/en/stable/settings.html#lua_ls_apidoc_separate_members"
         )
         if sys.platform == "win32" and is_case_insensitive:
             msg += (