mirror of
https://github.com/qpdf/qpdf.git
synced 2024-12-22 10:58:58 +00:00
Integration with readthedocs
This commit is contained in:
parent
d70fb568a3
commit
e8a15204f5
21
.readthedocs.yaml
Normal file
21
.readthedocs.yaml
Normal file
@ -0,0 +1,21 @@
|
||||
# .readthedocs.yaml
|
||||
# Read the Docs configuration file
|
||||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
||||
|
||||
# Required
|
||||
version: 2
|
||||
|
||||
build:
|
||||
os: ubuntu-20.04
|
||||
tools:
|
||||
python: "3.9"
|
||||
|
||||
sphinx:
|
||||
configuration: manual/conf.py
|
||||
|
||||
formats:
|
||||
- pdf
|
||||
- epub
|
||||
|
||||
sphinx:
|
||||
fail_on_warning: true
|
@ -403,3 +403,18 @@ whichever `./config-*` is appropriate for whichever compiler I need to
|
||||
test with. Start one of the Visual Studio native compiler shells, and
|
||||
from there, run one of the msys shells. The Visual Studio step is not
|
||||
necessary if just building with mingw.
|
||||
|
||||
|
||||
DOCS ON readthedocs.org
|
||||
|
||||
* Registered for an account at readthedocs.org with my github account
|
||||
* Project page: https://readthedocs.org/projects/qpdf/
|
||||
* Docs: https://qpdf.readthedocs.io/
|
||||
* Admin -> Settings
|
||||
* Set project home page
|
||||
* Advanced: Show version warning
|
||||
* Email Notifications: set email address for build failures
|
||||
|
||||
At this time, there is nothing in .github/workflows to support this.
|
||||
It's all set up as an integration directly between github and
|
||||
readthedocs.
|
||||
|
6
TODO
6
TODO
@ -1,6 +1,9 @@
|
||||
Next
|
||||
====
|
||||
|
||||
* At the time of the release, update the webpage to point to
|
||||
readthedocs if that's what we decide to do.
|
||||
|
||||
* High-level API/doc overhaul: #593
|
||||
|
||||
* Refactor test_driver.cc so that runtest is not one huge function.
|
||||
@ -32,9 +35,6 @@ Documentation
|
||||
* See #530 -- add an appendix explaining PDF encryption in general
|
||||
plus how it's handled by qpdf. Or maybe this should go on the wiki.
|
||||
|
||||
* Decide about readthedocs including supporting multiple released
|
||||
versions of the docs and docs from main.
|
||||
|
||||
Document-level work
|
||||
===================
|
||||
|
||||
|
@ -26,6 +26,9 @@ For a detailed list of changes, please see the file
|
||||
A top-to-bottom review of the documentation is planned for an
|
||||
upcoming release.
|
||||
|
||||
- Documentation is now available at `https://qpdf.readthedocs.io
|
||||
<https://qpdf.readthedocs.io>`__.
|
||||
|
||||
- Library Enhancements
|
||||
|
||||
- Since qpdf version 8, using object accessor methods on an
|
||||
|
Loading…
Reference in New Issue
Block a user