Skip to content

Commit abb8001

Browse files
committed
Update documentation to highlight internationalization and fix references
- Add Features section to README highlighting 33 language support - Fix pre-commit badge to reference 'main' branch instead of 'master' - Update setup.py to reference Executable Books team as maintainer - Update setup.py LONG_DESCRIPTION to mention internationalization - Enhance feature list in docs index page - Fix toctree reference capitalization - Update copyright year to 2025 in conf.py
1 parent eb1b4a4 commit abb8001

File tree

4 files changed

+21
-6
lines changed

4 files changed

+21
-6
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Documentation Status][rtd-badge]][rtd-link]
44
[![Github-CI][github-ci]][github-link]
55
[![Coverage Status][codecov-badge]][codecov-link]
6-
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/executablebooks/sphinx-proof/master.svg)](https://results.pre-commit.ci/latest/github/executablebooks/sphinx-proof/master)
6+
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/executablebooks/sphinx-proof/main.svg)](https://results.pre-commit.ci/latest/github/executablebooks/sphinx-proof/main)
77

88

99
**A proof extension for Sphinx**.
@@ -12,6 +12,14 @@ This package contains a [Sphinx](http://www.sphinx-doc.org/) extension
1212
for producing proof, theorem, axiom, lemma, definition, criterion, remark, conjecture,
1313
corollary, algorithm, example, property, observation, proposition and assumption directives.
1414

15+
## Features
16+
17+
- **15 directive types** for mathematical proofs and theorems
18+
- **Automatic numbering** of directives
19+
- **Cross-referencing** support via `prf:ref` role
20+
- **33 languages supported** - Complete translations for all directive types in English plus 32 additional languages (Arabic, Bengali, Bulgarian, Chinese, Czech, Danish, Dutch, Finnish, French, German, Greek, Hebrew, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Malay, Norwegian, Persian, Polish, Portuguese, Romanian, Russian, Spanish, Swedish, Thai, Turkish, Ukrainian, Urdu, Vietnamese)
21+
- **Customizable styling** with multiple theme options
22+
1523

1624
## Get started
1725

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# -- Project information -----------------------------------------------------
22

33
project = "sphinx-proof"
4-
copyright = "2024, QuantEcon Developers"
4+
copyright = "2025, QuantEcon Developers"
55
author = "QuantEcon Developers"
66
master_doc = "index"
77

docs/source/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
install
77
syntax
88
options
9-
Internationalization
9+
internationalization
1010
testing
1111
zreferences
1212
```
@@ -26,9 +26,11 @@ for producing [proof](syntax:proof), [theorem](syntax:theorem), [axiom](syntax:a
2626

2727
**Features**:
2828

29-
1. directives are automatically numbered
30-
2. supports directive options such as `class`, `label`, and `nonumber`
31-
3. can be referenced through the `prf:ref` role
29+
1. **15 directive types** - all automatically numbered with cross-referencing support
30+
2. **33 languages supported** - complete internationalization for global academic communities
31+
3. **Flexible options** - supports `class`, `label`, and `nonumber` directive options
32+
4. **Easy referencing** - use the `prf:ref` role to reference any directive
33+
5. **Customizable themes** - includes default and minimal theme options
3234

3335
(getting-started)=
3436
## Getting Started

setup.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@
1010
corollary, algorithm, example, property, observation, proposition, and
1111
assumption directives.
1212
13+
**Features:**
14+
- 15 directive types with automatic numbering and cross-referencing
15+
- Complete internationalization support for 33 languages
16+
- Customizable styling with multiple theme options
17+
1318
This project is maintained and supported by [najuzilu](https://github.com/najuzilu).
1419
"""
1520

0 commit comments

Comments
 (0)