aboutsummaryrefslogtreecommitdiffstats
path: root/manual/index.rst
AgeCommit message (Collapse)Author
2022-04-09Add documentation for code formatting and contribution guidelinesJay Berkenbilt
2022-03-19Add remimder to update list of files in CMakeLists.txtJay Berkenbilt
2022-02-01QPDFJob: documentationJay Berkenbilt
2022-01-30Generate help content from manualJay Berkenbilt
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.
2021-12-21Stop adding pre-built documentation to the source distributionJay Berkenbilt
2021-12-20Reference latest docs on readthedocsJay Berkenbilt
2021-12-19Add download section to docsJay Berkenbilt
2021-12-18Split documentation into multiple pages, change themeJay Berkenbilt
2021-12-18Add commentJay Berkenbilt
2021-12-17C API: simplify new error handling and improve documentationJay Berkenbilt
2021-12-17ChangeLog/doc for previous commitJay Berkenbilt
2021-12-17C API: add several stream functions (fixes #596)Jay Berkenbilt
2021-12-17Add Pl_Buffer::getMallocBufferJay Berkenbilt
2021-12-16C API: add functions for working with pages (fixes #594)Jay Berkenbilt
2021-12-14Fix minor typosm-holger
2021-12-13ChangeLog/release note on doc changeJay Berkenbilt
2021-12-13Work old "upgrading" sections into the release notesJay Berkenbilt
These are for ancient versions.
2021-12-13Remove superfluous "Upgrading to 4.0" chapterJay Berkenbilt
2021-12-13Doc: reorganize front sectionJay Berkenbilt
2021-12-13Doc: update requirements for building the documentationJay Berkenbilt
2021-12-13Remove "Indices and tables"Jay Berkenbilt
This was inserted by sphinx-quickstart, but it doesn't do anything for us.
2021-12-13Explicitly mark perl codeblock as suchJay Berkenbilt
2021-12-13Replace xref links to :ref:Jay Berkenbilt
Pandoc doesn't convert <xref> correctly, but it does so consistently, so this commit just changes all xref links to :ref:.
2021-12-13Replace <firstterm> with emphasisJay Berkenbilt
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-13Convert the original xml comment to an rst commentJay Berkenbilt
2021-12-13Replace <replaceable> with {...}Jay Berkenbilt
All occurrences are in :file: or :samp: now.
2021-12-13Wrap remaining replaceables in :samp:Jay Berkenbilt
2021-12-13Relabel replaceable in samp or fileJay Berkenbilt
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-13Convert <option> to :samp: and clean up literal blocksJay Berkenbilt
: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-13Replace things previously marked with <filename> with :file:`...`Jay Berkenbilt
2021-12-13Replace command|application with :command:`...`Jay Berkenbilt
Replace @1@...@2@ stuff from prior to the conversion with new representation.
2021-12-13doc: fix whitespace and indentation in pandoc outputJay Berkenbilt
Pandoc indented lists with two spaces after the dash, which is ugly and messes up emacs fill-paragraph. I transformed the spacing using a combination of this perl script and manual edits. I verified that the HTML generated by sphinx was identical before and after the edits and that this commit contains only whitespace changes. The perl script as it stands does not do indentation quite right for variable lists, but there were only about 8 cases that it missed, so I just fixed them manually. ```perl #!/usr/bin/env perl require 5.008; use warnings; use strict; use File::Basename; my $whoami = basename($0); my @liststack = (); while (<>) { if (m/^( *- )\S/) { my $pre = $1; while ((scalar(@liststack) > 0) && ($liststack[-1] >= length($pre))) { pop(@liststack); } if ((scalar(@liststack) == 0) && ($pre =~ m/^ /)) { push(@liststack, 1); } push(@liststack, length($pre)); my $n = scalar(@liststack); #print "** $n\n"; my $newpre = (' ' x ($n - 1)) . '- '; s/^$pre/$newpre/; } elsif (scalar(@liststack) > 0) { if ($_ ne "\n") { while (scalar(@liststack) > 0) { my $pre = m/^( *)/; if (length($1) < $liststack[-1]) { #print "XXX pop\n"; pop(@liststack); } else { last; } } my $n = scalar(@liststack); #print "** $n\n"; my $indent = ' ' x $n; s/^ +/$indent/; } } print; } ```
2021-12-13Fix errors introduced by pandocJay Berkenbilt
These showed up as warnings from sphinx-build
2021-12-12Insert output of pandoc as isJay Berkenbilt
pandoc -f docbook -t rst qpdf-manual.xml >| /tmp/a.rst Insert /tmp/a.rst into existing index.rst
2021-12-12Sphinx docs: tweak output of sphinx-quickstartJay Berkenbilt
2021-12-12Create initial sphinx document sourcesJay Berkenbilt
Run sphinx-quickstart. Throw everything away except conf.py and index.rst. We will incorporate this into our own build system.