Merge ~jugmac00/lazr.restfulclient:introduce-read-the-docs into lazr.restfulclient:main

Proposed by Jürgen Gmach
Status: Merged
Merge reported by: Jürgen Gmach
Merged at revision: 8d8afc1d99c82b3cfc1b7fe070087b1faf0d4e7c
Proposed branch: ~jugmac00/lazr.restfulclient:introduce-read-the-docs
Merge into: lazr.restfulclient:main
Diff against target: 72 lines (+13/-2)
5 files modified
CONTRIBUTING.rst (+5/-2)
NEWS.rst (+1/-0)
setup.py (+5/-0)
src/lazr/restfulclient/docs/CONTRIBUTING.rst (+1/-0)
src/lazr/restfulclient/docs/index.rst (+1/-0)
Reviewer Review Type Date Requested Status
Colin Watson (community) Approve
Review via email: mp+410941@code.launchpad.net

Commit message

Publish documentation on readthedocs.org

To post a comment you must log in.
Revision history for this message
Colin Watson (cjwatson) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/HACKING.rst b/CONTRIBUTING.rst
2similarity index 84%
3rename from HACKING.rst
4rename to CONTRIBUTING.rst
5index c7459c0..59d9e91 100644
6--- a/HACKING.rst
7+++ b/CONTRIBUTING.rst
8@@ -14,11 +14,14 @@
9 along with lazr.restfulclient. If not, see <http://www.gnu.org/licenses/>.
10
11 ============
12-Introduction
13+Contributing
14 ============
15
16-To run this project's tests, use `tox <https://tox.readthedocs.io/en/latest/>`.
17+To run this project's tests, use `tox <https://tox.readthedocs.io/en/latest/>`_.
18
19+To update the `project's documentation
20+<https://lazrrestfulclient.readthedocs.io/en/latest/>`_ you need to trigger a manual
21+build on the project's dashboard on https://readthedocs.org.
22
23 Getting help
24 ------------
25diff --git a/NEWS.rst b/NEWS.rst
26index 0192792..3559a22 100644
27--- a/NEWS.rst
28+++ b/NEWS.rst
29@@ -6,6 +6,7 @@ NEWS for lazr.restfulclient
30 ======
31
32 - Add ``pre-commit`` configuration.
33+ - Publish documentation on Read the Docs.
34
35 0.14.4 (2021-09-13)
36 ===================
37diff --git a/setup.py b/setup.py
38index bd4a0ed..2ddeb5b 100644
39--- a/setup.py
40+++ b/setup.py
41@@ -73,6 +73,11 @@ setup(
42 'wadllib>=1.1.4',
43 ],
44 url='https://launchpad.net/lazr.restfulclient',
45+ project_urls={
46+ "Source": "https://code.launchpad.net/lazr.restfulclient",
47+ "Issue Tracker": "https://bugs.launchpad.net/lazr.restfulclient",
48+ "Documentation": "https://lazrrestfulclient.readthedocs.io/en/latest/",
49+ },
50 download_url= 'https://launchpad.net/lazr.restfulclient/+download',
51 classifiers=[
52 "Development Status :: 5 - Production/Stable",
53diff --git a/src/lazr/restfulclient/docs/CONTRIBUTING.rst b/src/lazr/restfulclient/docs/CONTRIBUTING.rst
54new file mode 120000
55index 0000000..1d05313
56--- /dev/null
57+++ b/src/lazr/restfulclient/docs/CONTRIBUTING.rst
58@@ -0,0 +1 @@
59+../../../../CONTRIBUTING.rst
60\ No newline at end of file
61diff --git a/src/lazr/restfulclient/docs/index.rst b/src/lazr/restfulclient/docs/index.rst
62index e9aef29..61c08c3 100644
63--- a/src/lazr/restfulclient/docs/index.rst
64+++ b/src/lazr/restfulclient/docs/index.rst
65@@ -36,6 +36,7 @@ package.
66 caching
67 authorizer.standalone
68 retry.standalone
69+ CONTRIBUTING
70 NEWS
71
72 .. _Sphinx: http://sphinx.pocoo.org/

Subscribers

People subscribed via source and target branches