This series moves the crash documentation into the source tree and
builds the website from it:
- the whitepaper, the extension modules page and the maintenance
guide are converted to reStructuredText and built with Sphinx;
- "make doc" builds the documentation; "make website" additionally
generates the command help pages from the crash binary and the
changelog from the git log;
- a GitHub Actions workflow builds the site.
The pages were converted from the existing crash-utility.github.io
content, so some of it may be out of sync with the current code and
updates are welcome.
Testing:
- make -C doc website
- make website (requires a crash build)
Note:
- kudos to AI tools which helped a lot for the formating.
- Preview is available on my personal fork:
https://daveyoung.github.io/crash/
- Once the series merged, I will update the crash-utility.github.io index page
Add a short link there redirect to crash-utility.github.io/crash/
Rui Yang (13):
doc: convert the crash whitepaper to reStructuredText and add make doc
build: remove doc/output from "make clean"
website: build the docs and command help into _site
ci: add the website workflow
website: declutter the landing page
website: convert the extensions and maintenance pages to RST
website: generate the command help as Sphinx pages
website: add the contribution guidelines link and reorder the
navigation
website: add release downloads and changelog links
website: generate the changelog from the git log
website: note that the documentation may be out of sync
website: add Debian, Ubuntu and openSUSE build links
doc: credit the RST conversion
.github/workflows/website.yml | 71 +
.gitignore | 4 +
Makefile | 31 +
doc/.gitignore | 2 +
doc/Makefile | 48 +
doc/_static/.gitkeep | 0
doc/_static/crash.jpg | Bin 0 -> 3479 bytes
doc/conf.py | 73 +
doc/extensions.rst | 617 ++++
doc/index.rst | 20 +
doc/links.rst | 13 +
doc/maintenance.rst | 5587 +++++++++++++++++++++++++++++++++
doc/whitepaper.rst | 3442 ++++++++++++++++++++
scripts/gen-changelog.py | 82 +
scripts/gen-help-rst.py | 106 +
15 files changed, 10096 insertions(+)
create mode 100644 .github/workflows/website.yml
create mode 100644 doc/.gitignore
create mode 100644 doc/Makefile
create mode 100644 doc/_static/.gitkeep
create mode 100644 doc/_static/crash.jpg
create mode 100644 doc/conf.py
create mode 100644 doc/extensions.rst
create mode 100644 doc/index.rst
create mode 100644 doc/links.rst
create mode 100644 doc/maintenance.rst
create mode 100644 doc/whitepaper.rst
create mode 100644 scripts/gen-changelog.py
create mode 100644 scripts/gen-help-rst.py