16799635460
69%

Ran 07 Aug 2025 08:46AM UTC

Jobs 1

Files 75

Run time 4min

Badge

Embed ▾

Committed 07 Aug 2025 08:11AM UTC coverage: 68.803%. Remained the same

Build # 16799635460

Build Type

push

github

Committed by

web-flow

Commit Message

Documentation hosting on Github Pages (#11)

Before this PR, the only way to access the documentation was by browsing through the repository's markdown files.
Using the mkdocs framework, an alternative way was created to view documentation as a website.

This patch contains:
- Mkdocs config file `mkdocs.yml`.
- Small corrections in .md files for more correct rendering on the website.
- Custom hooks before site build to ensure .md file links remain
  accurate in both the website and repository versions of the docs.
- CI workflow to deploy the documentation site to GitHub Pages.

To check how the site looks locally, you need to:

```
make doc
```

Open documentation on http://localhost:8000/

Important:
- In the repository settings, set the Github Actions source for Github Pages.
  Settings -> Pages -> Build and deployment: "GitHub Actions"
- The documentation is deployed in the `github-pages` environment.
  You can set up rules for each environment (for example, a timer for deferred deployment)
  Settings -> Environment -> [env-name]

Co-authored-by: Vladimir Severov <hackallcode@users.noreply.github.com>

Run Details

4832 of 7023 relevant lines covered (68.8%)

0.9 hits per line

Jobs

ID	Job ID	Ran	Files	Coverage
1	16799635460.1	07 Aug 2025 08:46AM UTC	75	68.8	GitHub Action Run

tarantool / sdvg / 16799635460
69%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 16799635460

tarantool / sdvg / 16799635460 69%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 16799635460

tarantool / sdvg / 16799635460
69%

README BADGES
x