Documentation builder and publisher using Sphinx (Python)

Python 100%

Find a file

Twenty Panda c9384d1c62 structure: fix typos		2024-07-24 16:39:06 +02:00
.forgejo/workflows	ci: add Forgejo Actions and retire GitLab CI	2024-05-27 10:31:10 +02:00
doc	structure: fix typos	2024-07-24 16:39:06 +02:00
logo	add logo in various forms	2024-06-14 10:37:55 +02:00
.gitignore	Update `.gitignore`.	2023-09-13 10:12:42 +02:00
.gitmodules	release v2 as the first stable version	2024-06-19 23:23:27 +02:00
bot.py	gracefully handle discontinued forges	2024-01-24 11:45:51 +01:00
poetry.lock	upgrade f3wikidatabot to 0.0.6	2023-12-13 11:19:05 +01:00
pyproject.toml	version 2.0.1 now	2024-07-24 16:31:25 +02:00
README.md	README: the title should be Friendly Forge Format	2024-06-19 22:41:18 +02:00
RELEASE-NOTES.md	release v2 as the first stable version	2024-06-19 23:23:27 +02:00

README.md

Friendly Forge Format (F3) specifications

Source of the specifications, published here.

Setup

git clone --recursive https://code.forgejo.org/f3/f3-documentation.git
cd f3-documentation
echo layout python3 > .envrc
direnv allow
pip install poetry
poetry install

Build the documentation

Head to the doc directory and use:

poetry run make livehtml
# or 
poetry run make html

Fetch schemas updates

git submodule foreach git pull origin main

Upgrade from f3wikidatabot

Change the version in pyproject.toml.

poetry update f3wikidatabot

Update from Wikidata

python bot.py
git add doc/src/forges.md
git commit -m 'Update from wikidata'

Publish a release

F3 complies with semantic versioning.

Update doc/conf.py for a MINOR or MAJOR release, not for a PATCH release
Push the tag vX.Y.Z on
- JSON Schemas https://code.forgejo.org/f3/f3-schemas
- Specifications https://code.forgejo.org/f3/f3-documentation

Sphinx json schema

https://sphinx-jsonschema.readthedocs.io/en/latest/schemakeywords.html

License

This project is licensed under the AGPLv3+ License.