Skip to content

Commit 357f5f2

Browse files
committed
Doc/CI: Transition to ReadTheDocs, clean-up previous methods
- Remove HTML references to PDF documentation - Update HOWTO-RELEASE with new steps - Clean-up GitHub doc workflow
1 parent 4c3b426 commit 357f5f2

File tree

4 files changed

+9
-138
lines changed

4 files changed

+9
-138
lines changed

.github/workflows/doc_build.yml

Lines changed: 0 additions & 124 deletions
This file was deleted.

HOWTO-RELEASE

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,6 @@ See step 1.6 above. Do not rename the archives with RC postfixes.
182182
:s/^o/*/
183183

184184
- Update download links in `docs/source/download.rst`
185-
- Update `$TRAVIS_BRANCH` in `travis\after_success.sh` to new maintenance
186-
branch.
187185

188186

189187

@@ -241,13 +239,17 @@ version numbers in the files.
241239
*Commit changes. Either to master or maintenance branch depending on the nature
242240
of the release.*
243241

244-
3.2 Disable website deployment when releasing a new non-bugfix version
242+
3.2 Documentation
245243
-------------------------------------------------------------------------------
246244

247-
If the previous active version was, let's say, 6.1 and the new version is, let's say, 6.2,
248-
then checkout 6.1 branch, and in travis/after_success.sh, remove the code
249-
that causes commits to 6.1 to cause a website refresh, that is remove the
250-
code under `if test "$TRAVIS_SECURE_ENV_VARS" = "true" -a "$TRAVIS_BRANCH" = "6.1"; then`.
245+
HTML and PDF documentation is built using ReadTheDocs, which supports multiple
246+
versions. Versions are based on branch labels, e.g. "9.2". To modify settings,
247+
registered users must first log in. To add a version, go to
248+
https://readthedocs.org/projects/osgeo-proj/versions/ and click "Activate"
249+
next to the maintenance branch label.
250+
251+
The latest maintenance branch should be set as the "Default version" found at
252+
https://readthedocs.org/dashboard/osgeo-proj/advanced/
251253

252254
Also edit docs/source/conf.py to change the active branch for documentation
253255
in the `github_version` variable.

docs/source/download.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ Current Release
1515

1616
* **2023-03-01** `proj-9.2.0.tar.gz`_ (`md5`_)
1717
* **2023-03-01** `proj-data-1.13.tar.gz`_
18-
* **PDF Manual** `proj.pdf`_
1918

2019
.. note::
2120

@@ -163,4 +162,3 @@ Past Releases
163162
.. _`proj-datumgrid-oceania-1.1.zip`: https://download.osgeo.org/proj/proj-datumgrid-oceania-1.1.zip
164163
.. _`proj-datumgrid-oceania-1.2.zip`: https://download.osgeo.org/proj/proj-datumgrid-oceania-1.2.zip
165164
.. _`proj-datumgrid-world-1.0.zip`: https://download.osgeo.org/proj/proj-datumgrid-world-1.0.zip
166-
.. _`proj.pdf`: https://raw.githubusercontent.com/OSGeo/PROJ/gh-pages/proj.pdf

docs/source/index.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,3 @@ PROJ
3131
You can download the source code for PROJ on the :ref:`download section<download>`
3232
and find links to prepackaged executables in the
3333
:ref:`installation section<install>`.
34-
35-
In addition to this website the PROJ documentation is also available in `PDF`_
36-
form.
37-
38-
.. _`PDF`: https://raw.githubusercontent.com/OSGeo/proj.4/gh-pages/proj.pdf

0 commit comments

Comments
 (0)