Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
8c75f99
docs: migrate documentation to Dockle
ReenigneArcher Sep 18, 2026
816bacb
fix: refine Dockle migration
ReenigneArcher Sep 18, 2026
fdfcb95
chore: update Dockle pin
ReenigneArcher Sep 18, 2026
26f2850
chore: update Dockle pin
ReenigneArcher Sep 18, 2026
847518f
fix: track Dockle CDN pins
ReenigneArcher Sep 18, 2026
10beeb5
fix: preserve Read the Docs setup
ReenigneArcher Sep 19, 2026
2300da7
fix: refine Dockle documentation
ReenigneArcher Sep 19, 2026
c165254
chore: update Dockle
ReenigneArcher Sep 19, 2026
c41f0cb
build: update Dockle preview
ReenigneArcher Sep 19, 2026
b6ae79c
build: update Dockle preview
ReenigneArcher Sep 19, 2026
0ca1361
build: update Dockle preview
ReenigneArcher Sep 19, 2026
12b3193
chore(docs): update dockle renderer
ReenigneArcher Sep 19, 2026
ea51cfc
chore(docs): update dockle security fix
ReenigneArcher Sep 19, 2026
ef5f23d
chore(docs): update dockle quality fixes
ReenigneArcher Sep 19, 2026
740a389
fix(docs): refine Dockle integration
ReenigneArcher Sep 19, 2026
701f120
chore(docs): update Dockle
ReenigneArcher Sep 19, 2026
83254ae
fix(docs): update the Dockle build environment
ReenigneArcher Sep 19, 2026
d72a480
chore(docs): update Dockle
ReenigneArcher Sep 19, 2026
41aa9fb
chore(docs): update Dockle
ReenigneArcher Sep 19, 2026
1d220d7
chore(docs): update Dockle
ReenigneArcher Sep 19, 2026
70471af
chore(docs): update Dockle
ReenigneArcher Sep 19, 2026
361a574
chore: add dockle branding
ReenigneArcher Sep 19, 2026
618529e
docs: use dockle 2026.919.233535
ReenigneArcher Sep 20, 2026
c10d047
fix(docs): use standard Python on Read the Docs
ReenigneArcher Sep 20, 2026
93aec07
fix(docs): invoke Read the Docs uv tool directly
ReenigneArcher Sep 20, 2026
a0a55cc
docs: update Dockle and CrowdIn integration
ReenigneArcher Sep 20, 2026
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
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,10 @@ venv.bak/
# mkdocs documentation
/site

# Dockle
/.dockle/
/_site/

# mypy
.mypy_cache/
.dmypy.json
Expand Down
21 changes: 7 additions & 14 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,20 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python
build:
os: ubuntu-24.04
tools:
python: "3.14"
jobs:
post_build:
- rstcheck -r . # lint rst files
# - rstfmt --check --diff -w 120 . # check rst formatting

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: docs/source/conf.py
fail_on_warning: true

# Using Sphinx, build docs in additional formats
formats: all
build:
html:
- |
uv run --no-sync dockle check
uv run --no-sync dockle build
mkdir -p "${READTHEDOCS_OUTPUT}html/"
cp -r _site/. "${READTHEDOCS_OUTPUT}html/"

python:
install:
Expand Down
Binary file added branding/banners/dockle.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added branding/banners/dockle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions dockle.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[project]
name = "LizardByte"
version = "0.0.0"
description = "LizardByte organization documentation."
repository = "https://github.com/LizardByte/.github"
author = "LizardByte"
logo = "branding/logos/logo-512x512.png"
favicon = "branding/logos/favicon.ico"

[build]
output = "_site"
work = ".dockle"
strict = true
clean = true

[[targets]]
name = "docs"
title = "LizardByte documentation"
framework = "sphinx"
source = "docs/source"
home = true

[targets.sphinx]
static_paths = ["docs/source/_static"]
source_edit_link = "https://github.com/LizardByte/.github/blob/master/docs/source/{filename}"
extra_stylesheets = [
"https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@2026.920.12131/dist/crowdin-dockle-css.css",
]
extra_javascript = [
"https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@2026.920.12131/dist/crowdin.js",
"https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@2026.920.12131/dist/ranking-sorter.js",
"js/crowdin.js",
"js/projects.js",
]
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

35 changes: 0 additions & 35 deletions docs/make.bat

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/_static/js/crowdin.js
Original file line number Diff line number Diff line change
@@ -1 +1 @@
globalThis.initCrowdIn('LizardByte-docs', 'sphinx')
globalThis.initCrowdIn('LizardByte-docs', 'dockle')
15 changes: 15 additions & 0 deletions docs/source/about/donate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Donate

Want to support our work? You can donate to us via the following platforms:

[![GitHub Sponsors](https://img.shields.io/github/sponsors/lizardbyte?label=Github%20Sponsors&style=for-the-badge&color=green&logo=githubsponsors)](https://github.com/sponsors/LizardByte)

[![Patreon](https://img.shields.io/badge/dynamic/json?color=green&label=Patreon&style=for-the-badge&query=patron_count&url=https%3A%2F%2Fapp.lizardbyte.dev%2Fdashboard%2Fpatreon%2FLizardByte.json&logo=patreon)](https://www.patreon.com/LizardByte)

[![PayPal](https://img.shields.io/static/v1?style=for-the-badge&label=PayPal&message=Donate&color=green&logo=paypal)](https://www.paypal.com/paypalme/ReenigneArcher)

If you'd like to support us without donating, please consider starring your favorite LizardByte repositories.

Thank you to all our supporters!

![Sponsors](https://raw.githubusercontent.com/LizardByte/contributors/refs/heads/dist/sponsors.svg)
22 changes: 0 additions & 22 deletions docs/source/about/donate.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/source/about/overview.md

This file was deleted.

100 changes: 0 additions & 100 deletions docs/source/conf.py

This file was deleted.

59 changes: 59 additions & 0 deletions docs/source/developers/repository_standards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Repository standards

This document outlines the standards and best practices for LizardByte repositories to ensure consistency,
maintainability, and quality across all projects.

## Repository structure

### File organization

All repositories should follow a consistent structure:

```text
repository-name/
├── .github/
│ ├── matchers/ # custom problem matchers
│ ├── workflows/
│ │ ├── _codeql.yml
│ │ └── _common-lint.yml
│ ├── dependabot.yml
│ └── semantic.yml
├── branding/ # project specific branding assets
├── docs/ # structure varies depending on the doc system used
├── src/ # main source code
├── tests/ # if there are tests
├── third-party/ # location of submodules if any
├── .gitignore
├── LICENSE
└── README.md or README.rst
```

### Required files

Every repository must include:

- **LICENSE**: All projects must use an appropriate license.
- **README**: Primary documentation in reStructuredText (`.rst`) or Markdown (`.md`) format.
- **.gitignore**: Appropriate for the project's language and framework. See [GitHub's collection](https://github.com/github/gitignore) for starter templates.
- **.github/**: Contains GitHub-specific configurations such as workflows and issue templates.

## Naming conventions

### Repository names

- Be descriptive and concise.
- Avoid abbreviations unless widely understood.

### Branch names

- Use descriptive names with forward slashes for organization.
- Format: `type/short-description`.
- Types include `feat/`, `fix/`, `docs/`, and `refactor/`; see [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for a full list.
- Examples: `feat/user-authentication`, `fix/memory-leak`, `docs/api-reference`.

### File and directory names

- Be consistent within each project.
- Avoid spaces and special characters.

For questions about these standards or exceptions, open an issue in the [.github repository](https://github.com/LizardByte/.github) or contact the maintainers.
Loading
Loading