Merge ~jugmac00/lazr.restful:publish-docs-on-rtd into lazr.restful: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
diff --git a/HACKING.txt b/CONTRIBUTING.rst
0similarity index 85%0similarity index 85%
1rename from HACKING.txt1rename from HACKING.txt
2rename to CONTRIBUTING.rst2rename to CONTRIBUTING.rst
index 6172a8a..2234012 100644
--- a/HACKING.txt
+++ b/CONTRIBUTING.rst
@@ -14,11 +14,14 @@
14 along with lazr.restful. If not, see <http://www.gnu.org/licenses/>.14 along with lazr.restful. If not, see <http://www.gnu.org/licenses/>.
1515
16============16============
17Introduction17Contributing
18============18============
1919
20To run this project's tests, use `tox <https://tox.readthedocs.io/en/latest/>`.20To run this project's tests, use `tox <https://tox.readthedocs.io/en/latest/>`_.
2121
22To update the `project's documentation
23<https://lazrrestful.readthedocs.io/en/latest/>`_ you need to trigger a manual
24build on the project's dashboard on https://readthedocs.org.
2225
23Getting help26Getting help
24------------27------------
diff --git a/NEWS.rst b/NEWS.rst
index 9a03a7e..8a73089 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -7,6 +7,7 @@ NEWS for lazr.restful
77
8- Add support for Python 3.9 and 3.10.8- Add support for Python 3.9 and 3.10.
9- Add basic pre-commit configuration.9- Add basic pre-commit configuration.
10- Publish docs on Read the Docs.
1011
111.1.0 (2021-10-07)121.1.0 (2021-10-07)
12==================13==================
diff --git a/src/lazr/restful/docs/CONTRIBUTING.rst b/src/lazr/restful/docs/CONTRIBUTING.rst
13new file mode 12000014new file mode 120000
index 0000000..1d05313
--- /dev/null
+++ b/src/lazr/restful/docs/CONTRIBUTING.rst
@@ -0,0 +1 @@
1../../../../CONTRIBUTING.rst
0\ No newline at end of file2\ No newline at end of file
diff --git a/src/lazr/restful/docs/conf.py b/src/lazr/restful/docs/conf.py
index e1cdf5d..5a5b367 100644
--- a/src/lazr/restful/docs/conf.py
+++ b/src/lazr/restful/docs/conf.py
@@ -95,7 +95,7 @@ html_theme = 'alabaster'
95# Add any paths that contain custom static files (such as style sheets) here,95# Add any paths that contain custom static files (such as style sheets) here,
96# relative to this directory. They are copied after the builtin static files,96# relative to this directory. They are copied after the builtin static files,
97# so a file named "default.css" will overwrite the builtin "default.css".97# so a file named "default.css" will overwrite the builtin "default.css".
98html_static_path = ['_static']98html_static_path = []
9999
100# Custom sidebar templates, must be a dictionary that maps document names100# Custom sidebar templates, must be a dictionary that maps document names
101# to template names.101# to template names.
diff --git a/src/lazr/restful/docs/index.rst b/src/lazr/restful/docs/index.rst
index 0846d44..290ecae 100644
--- a/src/lazr/restful/docs/index.rst
+++ b/src/lazr/restful/docs/index.rst
@@ -90,4 +90,5 @@ Other Documents
90 multiversion90 multiversion
91 debug91 debug
92 django92 django
93 CONTRIBUTING
93 NEWS94 NEWS

Subscribers

People subscribed via source and target branches