Jay Berkenbilt
acf8d18b6e
Editorial changes to cli.rst
2022-01-30 13:11:03 -05:00
Jay Berkenbilt
a6df6fdaf7
CLI doc: use tables where helpful
2022-01-30 13:11:03 -05:00
Jay Berkenbilt
c529c28df6
Manual: use proper character for >=
2022-01-30 13:11:03 -05:00
Jay Berkenbilt
211f1fdfe1
Allow real <= and >= in LateX
2022-01-30 13:11:03 -05:00
Jay Berkenbilt
195ddf6f5a
Manual: convert more lists to tables
2022-01-30 13:11:03 -05:00
m-holger
ee632237f4
Manual: reformat P information as table
2022-01-30 13:11:03 -05:00
m-holger
1efcda1657
Manual: enable line wrapping in table cells
2022-01-30 13:11:03 -05:00
m-holger
f2a3b9cbfc
Fix manual typo
2022-01-30 13:11:03 -05:00
Jay Berkenbilt
5c5e5ca29b
Document how to add a command-line argument
2022-01-30 13:11:03 -05:00
Jay Berkenbilt
c8729398dd
Generate help content from manual
...
This is a massive rewrite of the help text and cli.rst section of the
manual. All command-line flags now have their own help and are
specifically index. qpdf --help is completely redone.
2022-01-30 13:11:03 -05:00
Jay Berkenbilt
36916619f0
Stop adding pre-built documentation to the source distribution
2021-12-21 09:52:41 -05:00
Jay Berkenbilt
fdf4d96ea2
Update manual pages
2021-12-20 20:07:33 -05:00
Jay Berkenbilt
db7bd6feef
Reference latest docs on readthedocs
2021-12-20 17:16:39 -05:00
Jay Berkenbilt
04745320d6
Prepare 10.5.0 release
2021-12-20 14:51:46 -05:00
Jay Berkenbilt
5d26f29eeb
Fix typo
2021-12-20 07:10:08 -05:00
Jay Berkenbilt
765373174f
Link to wiki
2021-12-19 17:35:15 -05:00
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
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
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
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
Jay Berkenbilt
feafcc4e88
C API: add several stream functions ( fixes #596 )
2021-12-17 13:28:11 -05:00
Jay Berkenbilt
fee7489ee4
Add Pl_Buffer::getMallocBuffer
2021-12-17 12:38:52 -05:00
Jay Berkenbilt
9bb6f570ec
C API: add functions for working with pages ( fixes #594 )
2021-12-16 15:07:48 -05:00
m-holger
6187c8086e
Fix minor typos
2021-12-14 12:06:03 -05:00
Jay Berkenbilt
43740ea733
ChangeLog/release note on doc change
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
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
Jay Berkenbilt
d13a6032e6
Replace <replaceable> with {...}
...
All occurrences are in :file: or :samp: now.
2021-12-13 11:20:14 -05:00
Jay Berkenbilt
0fdbb957a0
Wrap remaining replaceables in :samp:
2021-12-13 11:20:14 -05:00
Jay Berkenbilt
f4531e8a47
Relabel replaceable in samp or file
...
Replace @1@replaceable@1@...@2@replaceable@2@ with
@3@replaceable@3@...@3@replaceable@3@ inside of :samp: and :file: so
that all remaining @1@replaceable@1@...@2@replaceable@2@ are outside.
Since the {...} syntax for replaceable only works in :samp: and
:file:, we will have to enclose the remaining ones in :samp: for them
to work.
2021-12-13 11:20:14 -05:00
Jay Berkenbilt
bf4d107853
Convert <option> to :samp: and clean up literal blocks
...
:option: is stronger and assumes a reference to a list of options.
Since we don't have that yet, just use :samp: for options. Inside
literal code blocks, there is no expansion, so just remove markup.
2021-12-13 11:20:14 -05:00
