mirror of
https://github.com/qpdf/qpdf.git
synced 2024-12-22 10:58:58 +00:00
doc: switch html theme to sphinx_rtd_theme
This commit is contained in:
parent
d3501c4f3e
commit
92613a1eec
@ -31,6 +31,13 @@ Memory checks:
|
|||||||
--enable-werror --disable-shared
|
--enable-werror --disable-shared
|
||||||
|
|
||||||
|
|
||||||
|
CHECKING DOCS ON readthedocs
|
||||||
|
|
||||||
|
To check docs on readthedocs.io without running all of CI, push to the
|
||||||
|
doc-check branch. Then visit https://qpdf.readthedocs.io/en/doc-check/
|
||||||
|
Building docs from pull requests is also enabled.
|
||||||
|
|
||||||
|
|
||||||
GOOGLE OSS-FUZZ
|
GOOGLE OSS-FUZZ
|
||||||
|
|
||||||
* See ../misc/fuzz (not in repo) for unfixed, downloaded fuzz test cases
|
* See ../misc/fuzz (not in repo) for unfixed, downloaded fuzz test cases
|
||||||
|
@ -7,7 +7,7 @@ RUN apt-get update && \
|
|||||||
inkscape imagemagick busybox-static wget fuse && \
|
inkscape imagemagick busybox-static wget fuse && \
|
||||||
apt-get clean && \
|
apt-get clean && \
|
||||||
rm -rf /var/lib/apt/lists/*
|
rm -rf /var/lib/apt/lists/*
|
||||||
RUN pip3 install sphinx
|
RUN pip3 install sphinx sphinx_rtd_theme
|
||||||
COPY entrypoint /entrypoint
|
COPY entrypoint /entrypoint
|
||||||
RUN chmod +x /entrypoint
|
RUN chmod +x /entrypoint
|
||||||
ENTRYPOINT [ "/entrypoint" ]
|
ENTRYPOINT [ "/entrypoint" ]
|
||||||
|
@ -5,7 +5,7 @@ sudo apt-get -y install \
|
|||||||
autoconf build-essential zlib1g-dev libjpeg-dev libgnutls28-dev \
|
autoconf build-essential zlib1g-dev libjpeg-dev libgnutls28-dev \
|
||||||
libssl-dev python3-pip texlive-latex-extra latexmk \
|
libssl-dev python3-pip texlive-latex-extra latexmk \
|
||||||
inkscape imagemagick libtiff-tools ghostscript
|
inkscape imagemagick libtiff-tools ghostscript
|
||||||
pip3 install sphinx
|
pip3 install sphinx sphinx_rtd_theme
|
||||||
./configure --enable-werror --enable-doc-maintenance \
|
./configure --enable-werror --enable-doc-maintenance \
|
||||||
--enable-crypto-native --enable-crypto-openssl --enable-crypto-gnutls \
|
--enable-crypto-native --enable-crypto-openssl --enable-crypto-gnutls \
|
||||||
--enable-show-failed-test-output --enable-test-compare-images
|
--enable-show-failed-test-output --enable-test-compare-images
|
||||||
|
@ -5,7 +5,7 @@ sudo apt-get update
|
|||||||
sudo apt-get -y install \
|
sudo apt-get -y install \
|
||||||
autoconf build-essential zlib1g-dev libjpeg-dev \
|
autoconf build-essential zlib1g-dev libjpeg-dev \
|
||||||
python3-pip texlive-latex-extra latexmk inkscape imagemagick
|
python3-pip texlive-latex-extra latexmk inkscape imagemagick
|
||||||
pip3 install sphinx
|
pip3 install sphinx sphinx_rtd_theme
|
||||||
./configure --enable-doc-maintenance
|
./configure --enable-doc-maintenance
|
||||||
make -j$(nproc) build_manual
|
make -j$(nproc) build_manual
|
||||||
zip -r doc.zip doc/*html doc/*.pdf
|
zip -r doc.zip doc/*html doc/*.pdf
|
||||||
|
@ -6,14 +6,19 @@
|
|||||||
#
|
#
|
||||||
# To see the default sample conf.py, run sphinx-quickstart in an empty
|
# To see the default sample conf.py, run sphinx-quickstart in an empty
|
||||||
# directory. Most of the original comments and options were removed.
|
# directory. Most of the original comments and options were removed.
|
||||||
|
import sphinx_rtd_theme # noQA F401
|
||||||
|
|
||||||
project = 'QPDF'
|
project = 'QPDF'
|
||||||
copyright = '2005-2021, Jay Berkenbilt'
|
copyright = '2005-2021, Jay Berkenbilt'
|
||||||
author = 'Jay Berkenbilt'
|
author = 'Jay Berkenbilt'
|
||||||
release = '10.4.0'
|
release = '10.4.0'
|
||||||
version = release
|
version = release
|
||||||
html_theme = 'nature'
|
extensions = [
|
||||||
|
'sphinx_rtd_theme',
|
||||||
|
]
|
||||||
|
html_theme = 'sphinx_rtd_theme'
|
||||||
html_theme_options = {
|
html_theme_options = {
|
||||||
"body_max_width": None,
|
"body_max_width": None,
|
||||||
}
|
}
|
||||||
|
html_logo = '../logo/qpdf.svg'
|
||||||
highlight_language = 'none'
|
highlight_language = 'none'
|
||||||
|
@ -63,10 +63,11 @@ ghostscript.
|
|||||||
Pre-built documentation is distributed with qpdf, so you should
|
Pre-built documentation is distributed with qpdf, so you should
|
||||||
generally not need to rebuild the documentation. In order to build the
|
generally not need to rebuild the documentation. In order to build the
|
||||||
documentation from source, you need to install `Sphinx
|
documentation from source, you need to install `Sphinx
|
||||||
<https://sphinx-doc.org>`__. To build the PDF version of the
|
<https://sphinx-doc.org>`__ along with the ``sphinx_rtd_doc`` theme
|
||||||
documentation, you need ``pdflatex``, ``latexmk``, and a fairly complete
|
(``pip install sphinx sphinx_rtd_theme``). To build the PDF version of
|
||||||
LaTeX installation. Detailed requirements can be found in the Sphinx
|
the documentation, you need ``pdflatex``, ``latexmk``, and a fairly
|
||||||
documentation.
|
complete LaTeX installation. Detailed requirements can be found in the
|
||||||
|
Sphinx documentation.
|
||||||
|
|
||||||
.. _building:
|
.. _building:
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user