Commit e8a15204f5e0a0e259ff8ae337a94c07b7f67092
1 parent
d70fb568
Integration with readthedocs
Showing
4 changed files
with
42 additions
and
3 deletions
.readthedocs.yaml
0 → 100644
| 1 | +# .readthedocs.yaml | ||
| 2 | +# Read the Docs configuration file | ||
| 3 | +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
| 4 | + | ||
| 5 | +# Required | ||
| 6 | +version: 2 | ||
| 7 | + | ||
| 8 | +build: | ||
| 9 | + os: ubuntu-20.04 | ||
| 10 | + tools: | ||
| 11 | + python: "3.9" | ||
| 12 | + | ||
| 13 | +sphinx: | ||
| 14 | + configuration: manual/conf.py | ||
| 15 | + | ||
| 16 | +formats: | ||
| 17 | |||
| 18 | + - epub | ||
| 19 | + | ||
| 20 | +sphinx: | ||
| 21 | + fail_on_warning: true |
README-maintainer
| @@ -403,3 +403,18 @@ whichever `./config-*` is appropriate for whichever compiler I need to | @@ -403,3 +403,18 @@ whichever `./config-*` is appropriate for whichever compiler I need to | ||
| 403 | test with. Start one of the Visual Studio native compiler shells, and | 403 | test with. Start one of the Visual Studio native compiler shells, and |
| 404 | from there, run one of the msys shells. The Visual Studio step is not | 404 | from there, run one of the msys shells. The Visual Studio step is not |
| 405 | necessary if just building with mingw. | 405 | necessary if just building with mingw. |
| 406 | + | ||
| 407 | + | ||
| 408 | +DOCS ON readthedocs.org | ||
| 409 | + | ||
| 410 | +* Registered for an account at readthedocs.org with my github account | ||
| 411 | +* Project page: https://readthedocs.org/projects/qpdf/ | ||
| 412 | +* Docs: https://qpdf.readthedocs.io/ | ||
| 413 | +* Admin -> Settings | ||
| 414 | + * Set project home page | ||
| 415 | + * Advanced: Show version warning | ||
| 416 | + * Email Notifications: set email address for build failures | ||
| 417 | + | ||
| 418 | +At this time, there is nothing in .github/workflows to support this. | ||
| 419 | +It's all set up as an integration directly between github and | ||
| 420 | +readthedocs. |
TODO
| 1 | Next | 1 | Next |
| 2 | ==== | 2 | ==== |
| 3 | 3 | ||
| 4 | +* At the time of the release, update the webpage to point to | ||
| 5 | + readthedocs if that's what we decide to do. | ||
| 6 | + | ||
| 4 | * High-level API/doc overhaul: #593 | 7 | * High-level API/doc overhaul: #593 |
| 5 | 8 | ||
| 6 | * Refactor test_driver.cc so that runtest is not one huge function. | 9 | * Refactor test_driver.cc so that runtest is not one huge function. |
| @@ -32,9 +35,6 @@ Documentation | @@ -32,9 +35,6 @@ Documentation | ||
| 32 | * See #530 -- add an appendix explaining PDF encryption in general | 35 | * See #530 -- add an appendix explaining PDF encryption in general |
| 33 | plus how it's handled by qpdf. Or maybe this should go on the wiki. | 36 | plus how it's handled by qpdf. Or maybe this should go on the wiki. |
| 34 | 37 | ||
| 35 | -* Decide about readthedocs including supporting multiple released | ||
| 36 | - versions of the docs and docs from main. | ||
| 37 | - | ||
| 38 | Document-level work | 38 | Document-level work |
| 39 | =================== | 39 | =================== |
| 40 | 40 |
manual/release-notes.rst
| @@ -26,6 +26,9 @@ For a detailed list of changes, please see the file | @@ -26,6 +26,9 @@ For a detailed list of changes, please see the file | ||
| 26 | A top-to-bottom review of the documentation is planned for an | 26 | A top-to-bottom review of the documentation is planned for an |
| 27 | upcoming release. | 27 | upcoming release. |
| 28 | 28 | ||
| 29 | + - Documentation is now available at `https://qpdf.readthedocs.io | ||
| 30 | + <https://qpdf.readthedocs.io>`__. | ||
| 31 | + | ||
| 29 | - Library Enhancements | 32 | - Library Enhancements |
| 30 | 33 | ||
| 31 | - Since qpdf version 8, using object accessor methods on an | 34 | - Since qpdf version 8, using object accessor methods on an |