Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 2 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ build:
then
exit 183;
fi
apt_packages:
- distro-info

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down
2 changes: 2 additions & 0 deletions docs/.sphinx/spellingcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,5 @@ matrix:
- img
- a.p-navigation__link
- a.contributor
- a.manpage.reference.external

8 changes: 8 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import datetime
import ast
import os
import sys
import yaml

# Configuration for the Sphinx documentation builder.
Expand Down Expand Up @@ -282,6 +283,13 @@
# manpages_url = 'https://manpages.ubuntu.com/manpages/{codename}/en/' + \
# 'man{section}/{page}.{section}.html'

import distro_info

sys.path.append('/usr/lib/python3/dist-packages')

manpages_url = ("https://manpages.ubuntu.com/manpages/"
f"{distro_info.UbuntuDistroInfo().stable()}/en/"
"man{section}/{page}.{section}.html")

# Specifies a reST snippet to be prepended to each .rst file
# This defines a :center: role that centers table cell content.
Expand Down
20 changes: 10 additions & 10 deletions docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ ARMv8
See {term}`arm64`

autopkgtest
:manpage:`autopkgtest(1)` is a software that interprets and executes tests
{manpage}`autopkgtest(1)` is a software that interprets and executes tests
found in {term}`source packages <Source Package>` that follow the {term}`DEP-8`
specification.

Expand Down Expand Up @@ -192,8 +192,8 @@ Big-Endian

Binary Package
A {term}`Debian` **binary package** is a standardized format with the file
extension `.deb` that the {term}`Package Manager` (:manpage:`dpkg(1)` or
:manpage:`apt(8)`) can understand to install and uninstall software on a
extension `.deb` that the {term}`Package Manager` ({manpage}`dpkg(1)` or
{manpage}`apt(8)`) can understand to install and uninstall software on a
target machine to simplify distributing software to a target machine and
managing software on a target machine.

Expand Down Expand Up @@ -520,8 +520,8 @@ diff
format (e.g. `.bin`, `.png`, `.jpg`).

See also:
* :manpage:`diff(1)`
* :manpage:`git-diff(1)`
* {manpage}`diff(1)`
* {manpage}`git-diff(1)`

Discourse
An {term}`open-source <Open Source Software>` forum software that is used
Expand Down Expand Up @@ -1023,12 +1023,12 @@ orig tarball
Also known as "original tarball". The `.orig.tar.ext` and
`.orig-component.tar.ext` (where `ext` can be `gz`, `bz2`, `lzma` and `xz`
and `component` can contain alphanumeric characters (`a-zA-Z0-9`) and
hyphens `-`) :manpage:`tar(5)` archive files of a {term}`Debian`
hyphens `-`) {manpage}`tar(5)` archive files of a {term}`Debian`
{term}`Source Package` that contains the original {term}`Source`
of the {term}`Upstream` project.

See also:
* :manpage:`dpkg-source(1)`
* {manpage}`dpkg-source(1)`
* {term}`tarball`

OS
Expand Down Expand Up @@ -1248,7 +1248,7 @@ Signature
packages verify that the {term}`Source Code` is from the developers of the
upstream project.

The tool :manpage:`gpg(1)` is commonly used to create and modify digital
The tool {manpage}`gpg(1)` is commonly used to create and modify digital
signatures. Further information can be found in the
[GNU Privacy Handbook](https://www.gnupg.org/gph/en/manual.html#AEN136).

Expand Down Expand Up @@ -1316,7 +1316,7 @@ Standard Output
*Work in Progress*

tarball
A file in the :manpage:`tar(5)` archive format, which collects any number of
A file in the {manpage}`tar(5)` archive format, which collects any number of
files, directories, and other file system objects (symbolic links, device nodes, etc.)
into a single stream of bytes. The format was originally designed to be used with
tape drives, but nowadays it is widely used as a general packaging mechanism.
Expand Down Expand Up @@ -1634,7 +1634,7 @@ Watch File

See also:
* [Basic overview of the `debian/` directory](https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/reference/debian-dir-overview/)
* :manpage:`uscan(1)`
* {manpage}`uscan(1)`
* [Section 4.11. Upstream source location (Debian Policy Manual v4.6.2.0)](https://www.debian.org/doc/debian-policy/ch-source.html#upstream-source-location-debian-watch)

WoU
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ canonical-sphinx[full]
sphinxcontrib-svg2pdfconverter[CairoSVG]
sphinx-last-updated-by-git
sphinxcontrib-mermaid
distro_info
Loading