Commit Graph

1982 Commits

Author SHA1 Message Date
Jay Berkenbilt 04a602aa50 Add download section to docs 2021-12-19 16:52:06 -05:00
Jay Berkenbilt ea73bf72e0 Further improvements to handling binary strings 2021-12-19 14:30:45 -05:00
Jay Berkenbilt 92613a1eec doc: switch html theme to sphinx_rtd_theme 2021-12-19 13:57:47 -05:00
Jay Berkenbilt d3501c4f3e Fix LGTM alerts 2021-12-18 16:25:53 -05:00
Jay Berkenbilt bf426a07fd Add docs badge to README 2021-12-18 16:25:53 -05:00
Jay Berkenbilt 1f07e94eb2 Update configuration for correct building of epub 2021-12-18 16:25:50 -05:00
Jay Berkenbilt c3dc03c713 Update configuration for correct building of epub 2021-12-18 15:59:04 -05:00
Jay Berkenbilt e8a15204f5 Integration with readthedocs 2021-12-18 15:44:54 -05:00
Jay Berkenbilt d70fb568a3 Specify highlight language instead of using text codeblocks 2021-12-18 13:43:58 -05:00
Jay Berkenbilt 0e6b6a240b Change html theme again, fix code blocks
The agogo theme doesn't do very well on narrow screens. The code
blocks were used for shell commands but were using Python syntax
highlighting.
2021-12-18 13:37:11 -05:00
Jay Berkenbilt c9d54fda51 Remove ref. from documentation references 2021-12-18 12:30:00 -05:00
Jay Berkenbilt 426b4ce856 Update documentation build/installation 2021-12-18 12:20:56 -05:00
Jay Berkenbilt eb20b4d0cb Remove unused import 2021-12-18 11:05:51 -05:00
Jay Berkenbilt c809f87706 Fix Acknowledgments section 2021-12-18 11:05:51 -05:00
Jay Berkenbilt 10fb619d3e Split documentation into multiple pages, change theme 2021-12-18 11:05:51 -05:00
Jay Berkenbilt f3d1138b8a Add comment 2021-12-18 11:05:51 -05:00
Jay Berkenbilt 408e900fe4 Fix qpdf-manual build dependencies 2021-12-18 11:05:51 -05:00
Jay Berkenbilt e19114df7a Remove unneeded paragraph from comments 2021-12-18 11:05:51 -05:00
Jay Berkenbilt ddbe59179e C API: simplify new error handling and improve documentation 2021-12-17 15:59:47 -05:00
Jay Berkenbilt 59a64115a6 ChangeLog/doc for previous commit 2021-12-17 14:28:20 -05:00
m-holger f6293bd94c C-API expose QPDFObjectHandle::getTypeCode and getTypeName (fixes #597) 2021-12-17 14:24:43 -05:00
Jay Berkenbilt feafcc4e88 C API: add several stream functions (fixes #596) 2021-12-17 13:28:11 -05:00
Jay Berkenbilt a0dbb71a64 Spell check 2021-12-17 12:38:52 -05:00
Jay Berkenbilt c40f8b5329 Make object types available to C API 2021-12-17 12:38:52 -05:00
Jay Berkenbilt cce715cd0e TODO: spell check 2021-12-17 12:38:52 -05:00
Jay Berkenbilt fee7489ee4 Add Pl_Buffer::getMallocBuffer 2021-12-17 12:38:52 -05:00
Jay Berkenbilt 8c4ad6b946 README-maintainer note: configure with doc maintenance 2021-12-17 12:38:52 -05:00
Jay Berkenbilt e4ef3d1540 Remove original qpdf fuzz seed corpus from tests
Since the introduction of fuzz testing, there has never been a problem
found because of a failure of a file in the fuzzer seed corpus. As the
fuzzer has found problems, they have been added to the test suite, and
that should be adequate to exercise the fuzzers in the tesing
environment as well as providing adequate regression testing.

Removing these original files shaves many minutes off the builds in CI.
2021-12-16 15:53:24 -05:00
Jay Berkenbilt 4024953682 Output C test n done at the end of each qpdf-ctest 2021-12-16 15:40:56 -05:00
Jay Berkenbilt 9bb6f570ec C API: add functions for working with pages (fixes #594) 2021-12-16 15:07:48 -05:00
Jay Berkenbilt f072be032f qpdf-ctest: outfile2 -> xarg 2021-12-16 11:51:16 -05:00
Jay Berkenbilt 3f9d50b526 Change name of formal parameters from data to qpdf 2021-12-16 11:51:15 -05:00
Jay Berkenbilt 245ca28066 Use value rather than reference captures where possible 2021-12-16 11:47:07 -05:00
Jay Berkenbilt addd6bef95 TODO: documentation updates 2021-12-15 14:29:58 -05:00
m-holger 6187c8086e Fix minor typos 2021-12-14 12:06:03 -05:00
Jay Berkenbilt 7707a1d356 Disable ci-fuzz build on build branch
I run the fuzzer test suite, which should be good enough to avoid
wasting resources on this every time I push to build.
2021-12-13 11:20:14 -05:00
Jay Berkenbilt 2cee5591f3 Avoid /tmp when building distribution 2021-12-13 11:20:14 -05:00
Jay Berkenbilt 43740ea733 ChangeLog/release note on doc change 2021-12-13 11:20:14 -05:00
Jay Berkenbilt 61f52cb6ac Update release-notes link 2021-12-13 11:20:14 -05:00
Jay Berkenbilt 2f938d4f13 Work old "upgrading" sections into the release notes
These are for ancient versions.
2021-12-13 11:20:14 -05:00
Jay Berkenbilt 003b4c9670 Remove superfluous "Upgrading to 4.0" chapter 2021-12-13 11:20:14 -05:00
Jay Berkenbilt cfaaea6f05 Doc: reorganize front section 2021-12-13 11:20:14 -05:00
Jay Berkenbilt ed6fe01238 Remove docbook manual and associated files 2021-12-13 11:20:14 -05:00
Jay Berkenbilt 39779dd3c8 Minor doc cleanup, update spelling checker 2021-12-13 11:20:14 -05:00
Jay Berkenbilt 948c4546c8 Doc: update requirements for building the documentation 2021-12-13 11:20:14 -05:00
Jay Berkenbilt aaea245a8d Remove "Indices and tables"
This was inserted by sphinx-quickstart, but it doesn't do anything for us.
2021-12-13 11:20:14 -05:00
Jay Berkenbilt e10e787413 Explicitly mark perl codeblock as such 2021-12-13 11:20:14 -05:00
Jay Berkenbilt cac844e07a Replace xref links to :ref:
Pandoc doesn't convert <xref> correctly, but it does so consistently,
so this commit just changes all xref links to :ref:.
2021-12-13 11:20:14 -05:00
Jay Berkenbilt 1b55906a04 Replace <firstterm> with emphasis
At one time, it seems that I was starting to use the <firstterm>
feature of docbook, but I forgot about it long ago, and there is
nothing consistent. In the absence of an actual glossary, just use
emphasis for terminology and don't tag it in any special way. This
could be fixed later if we wanted to.
2021-12-13 11:20:14 -05:00
Jay Berkenbilt e5a7d9323f Convert the original xml comment to an rst comment 2021-12-13 11:20:14 -05:00