Skip to content

Team manual back2tex #2242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Remove rst2pdf dependency.
  • Loading branch information
thijskh committed Nov 24, 2023
commit d4baab38ea23642070141113256cf1f7bbf0bcb0
15 changes: 0 additions & 15 deletions doc/manual/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
extensions = [
'sphinx.ext.ifconfig',
# 'sphinx_rtd_theme',
'rst2pdf.pdfbuilder',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -231,17 +230,3 @@


# -- Extension configuration -------------------------------------------------

# Options specifically for the Team manual PDF

pdf_compressed = True
pdf_stylesheets = ['sphinx','kerning','a4']

pdf_use_coverpage = False

# This is of string type, not bool. See: https://github.com/rst2pdf/rst2pdf/pull/846
pdf_use_toc = ''

# This is needed to avoid a bug in rst2pdf << 0.94 (Debian buster has 0.93)
# See: https://github.com/rst2pdf/rst2pdf/issues/678
pdf_invariant = False
22 changes: 12 additions & 10 deletions doc/manual/develop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,21 @@ already listed under
:ref:`judgehost <judgehost_requirements>` and
:ref:`submit client <submit_client_requirements>` requirements)::

sudo apt install autoconf automake bats \
python-sphinx python-sphinx-rtd-theme rst2pdf fontconfig python3-yaml latexmk

On Debian 11 (Bullseye) and above, instead install::

sudo apt install autoconf automake bats \
python3-sphinx python3-sphinx-rtd-theme rst2pdf fontconfig python3-yaml \
latexmk texlive-latex-recommended texlive-latex-extra tex-gyre
sudo apt install autoconf automake

When this software is present, bootstrapping can be done by running
``make dist``, which creates the ``configure`` script,
downloads and installs the PHP dependencies via composer and
generates documentation from RST/LaTeX sources.
downloads and installs the PHP dependencies via composer.

Rebuilding the documentation
----------------------------

Should you wish to rebuild the DOMjudge manual, you need the
following software installed::

sudo apt install python3-sphinx python3-yaml

Then run ``make docs`` to rebuild them.

Maintainer mode installation
----------------------------
Expand Down
11 changes: 3 additions & 8 deletions doc/manual/install-workstation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ to inspect its configuration and options.
Rebuilding team documentation
-----------------------------

The source of the team manual can be found in ``doc/manual/team.rst``.
The source of the team manual can be found in ``doc/team/``.
The team manual can incorporate specific settings of your environment,
most notably the URL of the DOMjudge installation. To achieve this,
rebuild the team manual *after* configuration of the system.
Expand All @@ -84,13 +84,8 @@ When DOMjudge is configured and site-specific configuration set,
the team manual can be generated with the command ``make docs``.
The following should do it on a Debian-like system::

sudo apt install python-sphinx python-sphinx-rtd-theme rst2pdf fontconfig python3-yaml
cd <INSTALL_PATH>/doc/
sudo apt install make texlive-latex-extra texlive-latex-recommended texlive-lang-european
cd <INSTALL_PATH>/docs/team
make docs

On Debian 11 and above, install
``python3-sphinx python3-sphinx-rtd-theme rst2pdf fontconfig python3-yaml`` instead.

The resulting manual will then be found in the ``team/`` subdirectory.

.. _netrc manual page: https://ec.haxx.se/usingcurl/usingcurl-netrc
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy