Skip to content

Commit 28060dd

Browse files
committed
fix: updated documentation
- Changed the documentation language. - Added 'docs' extra_require section in setup.py for documentation-related dependencies. - Updated installation instructions in installation.md to use `pip install light-api`.
1 parent 715c5a5 commit 28060dd

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

docs/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Installation
55
### Install LightAPI via pip:
66

77
``` bash
8-
pip install LightApi
8+
pip install light-api
99
```
1010
### PyPI Page
1111

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ edit_uri: https://github.com/giulio333/LightAPI/edit/main/docs
99
theme:
1010
name: material
1111
#custom_dir: overrides
12-
language: it
12+
language: en
1313
font:
1414
text: DM Sans
1515
icon:

setup.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,15 @@
2222
],
2323
extras_require={
2424
'test': ['pytest'],
25+
'docs': [
26+
'mkdocs-material',
27+
'mkdocstrings[python]',
28+
'mkdocs-glightbox',
29+
'mkdocs-awesome-pages-plugin',
30+
'mkdocs-git-committers-plugin-2',
31+
'mkdocs-git-revision-date-localized-plugin',
32+
'mkdocs-git-authors-plugin',
33+
]
2534
},
2635
classifiers=[
2736
'Programming Language :: Python :: 3',

0 commit comments

Comments
 (0)