lazr.restful

Merge ~jugmac00/lazr.restful:publish-docs-on-rtd into lazr.restful:main

  1. Git
  2. lp:~jugmac00/lazr.restful
  3. publish-docs-on-rtd
  4. Merge into main
Proposed by Jürgen Gmach
Status: Merged
Merge reported by: Jürgen Gmach
Merged at revision: dcfe5cfdba866669a9609134572c33315eff6a97
Proposed branch: ~jugmac00/lazr.restful:publish-docs-on-rtd
Merge into: lazr.restful:main
Diff against target: 67 lines (+9/-3)
5 files modified
CONTRIBUTING.rst (+5/-2)
NEWS.rst (+1/-0)
src/lazr/restful/docs/CONTRIBUTING.rst (+1/-0)
src/lazr/restful/docs/conf.py (+1/-1)
src/lazr/restful/docs/index.rst (+1/-0)
Reviewer Review Type Date Requested Status
Colin Watson (community) Approve
Review via email: mp+411322@code.launchpad.net

Commit message

Publish documentation on Read the Docs

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.txt b/CONTRIBUTING.rst
2similarity index 85%
3rename from HACKING.txt
4rename to CONTRIBUTING.rst
5index 6172a8a..2234012 100644
6--- a/HACKING.txt
7+++ b/CONTRIBUTING.rst
8@@ -14,11 +14,14 @@
9 along with lazr.restful. 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://lazrrestful.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 9a03a7e..8a73089 100644
27--- a/NEWS.rst
28+++ b/NEWS.rst
29@@ -7,6 +7,7 @@ NEWS for lazr.restful
30
31 - Add support for Python 3.9 and 3.10.
32 - Add basic pre-commit configuration.
33+- Publish docs on Read the Docs.
34
35 1.1.0 (2021-10-07)
36 ==================
37diff --git a/src/lazr/restful/docs/CONTRIBUTING.rst b/src/lazr/restful/docs/CONTRIBUTING.rst
38new file mode 120000
39index 0000000..1d05313
40--- /dev/null
41+++ b/src/lazr/restful/docs/CONTRIBUTING.rst
42@@ -0,0 +1 @@
43+../../../../CONTRIBUTING.rst
44\ No newline at end of file
45diff --git a/src/lazr/restful/docs/conf.py b/src/lazr/restful/docs/conf.py
46index e1cdf5d..5a5b367 100644
47--- a/src/lazr/restful/docs/conf.py
48+++ b/src/lazr/restful/docs/conf.py
49@@ -95,7 +95,7 @@ html_theme = 'alabaster'
50 # Add any paths that contain custom static files (such as style sheets) here,
51 # relative to this directory. They are copied after the builtin static files,
52 # so a file named "default.css" will overwrite the builtin "default.css".
53-html_static_path = ['_static']
54+html_static_path = []
55
56 # Custom sidebar templates, must be a dictionary that maps document names
57 # to template names.
58diff --git a/src/lazr/restful/docs/index.rst b/src/lazr/restful/docs/index.rst
59index 0846d44..290ecae 100644
60--- a/src/lazr/restful/docs/index.rst
61+++ b/src/lazr/restful/docs/index.rst
62@@ -90,4 +90,5 @@ Other Documents
63 multiversion
64 debug
65 django
66+ CONTRIBUTING
67 NEWS

Subscribers

People subscribed via source and target branches