2020-09-01 18:28:33 +00:00
|
|
|
LinkChecker Documentation
|
|
|
|
|
=========================
|
|
|
|
|
|
|
|
|
|
LinkChecker is documented with man pages and HTML that is used for the project web site.
|
|
|
|
|
Both are generated using Sphinx, with Makefiles provided to simplify the process.
|
|
|
|
|
|
|
|
|
|
Sources are found in doc/src. Stand-alone .rst files from doc/ are also included.
|
|
|
|
|
|
|
|
|
|
In addition to Sphinx the dependencies for building the documentation are:
|
|
|
|
|
|
|
|
|
|
graphviz
|
|
|
|
|
|
|
|
|
|
sphinx_epytext
|
|
|
|
|
|
|
|
|
|
sphinx_rtd_theme
|
|
|
|
|
|
2021-12-17 19:25:43 +00:00
|
|
|
sphinx_sitemap
|
|
|
|
|
|
2020-10-15 18:35:24 +00:00
|
|
|
Configuration
|
|
|
|
|
-------------
|
|
|
|
|
|
2022-09-13 18:32:06 +00:00
|
|
|
Before building either man pages or HTML, generate ``linkcheck/_release.py``
|
|
|
|
|
containing copyright, author and version with:
|
|
|
|
|
|
2022-09-13 18:32:06 +00:00
|
|
|
``hatchling build -t sdist --hooks-only``
|
2020-10-15 18:35:24 +00:00
|
|
|
|
2020-09-01 18:28:33 +00:00
|
|
|
|
|
|
|
|
Man Pages
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Source files are in doc/src/man.
|
|
|
|
|
|
|
|
|
|
The pages can be built with:
|
|
|
|
|
|
2022-09-13 18:32:06 +00:00
|
|
|
``linkchecker/doc $ make man``
|
2020-09-01 18:28:33 +00:00
|
|
|
|
|
|
|
|
The files are saved in doc/man.
|
|
|
|
|
|
|
|
|
|
See translations.md for information about creating localised man pages.
|
|
|
|
|
|
|
|
|
|
Published man pages are included in the LinkChecker repository.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
HTML
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
Build the HTML files with:
|
|
|
|
|
|
2022-09-13 18:32:06 +00:00
|
|
|
``linkchecker/doc $ make html``
|
2020-09-01 18:28:33 +00:00
|
|
|
|
|
|
|
|
The files are saved in doc/html.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Publishing the Web Site
|
|
|
|
|
-----------------------
|
|
|
|
|
|
2021-01-14 19:48:22 +00:00
|
|
|
The Web Site is hosted by GitHub Pages from the gh-pages branch.
|
2020-09-01 18:28:33 +00:00
|
|
|
|
2021-01-14 19:48:22 +00:00
|
|
|
A ``.nojekyll`` file is present to ensure folders beginning with an underscore
|
|
|
|
|
are published.
|
2020-09-01 18:28:33 +00:00
|
|
|
|
2020-10-13 18:28:48 +00:00
|
|
|
When updates to LinkChecker are pushed, the web site is built and published
|
|
|
|
|
automatically by a GitHub action ``.github/workflows/publish-pages.yml``.
|
