Skip to content

Commit ed11b24

Browse files
wilmermWilmer Martinez
andauthored
Develop (#21)
* Actualizar enlaces y rutas en la documentación y archivos de configuración para reflejar el cambio de nombre del repositorio a "alanube-python". * Actualizar sección de créditos en README.md: agregar a Oriku Precious como colaborador de documentación. * Actualizar versión a 1.0.1 y agregar URL de documentación en pyproject.toml * Actualizar la licencia en pyproject.toml a "MIT" y eliminar la referencia redundante en classifiers. * Actualizar flujo de trabajo de documentación: cambiar de Python a Ruby y ajustar comandos de construcción --------- Co-authored-by: Wilmer Martinez <info@wilmermartinez.dev>
1 parent 4b0d994 commit ed11b24

10 files changed

Lines changed: 130 additions & 128 deletions

File tree

.github/workflows/docs.yml

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,21 @@ jobs:
2424
- name: Checkout
2525
uses: actions/checkout@v4
2626

27-
- name: Setup Python
28-
uses: actions/setup-python@v4
27+
- name: Set up Ruby
28+
uses: ruby/setup-ruby@v1
2929
with:
30-
python-version: '3.10'
31-
32-
- name: Install dependencies
33-
run: |
34-
python -m pip install --upgrade pip
35-
pip install jekyll jekyll-seo-tag jekyll-sitemap
30+
ruby-version: '3.2' # Puedes usar otra versión si lo deseas
31+
bundler-cache: true
32+
working-directory: docs
3633

3734
- name: Setup Pages
3835
uses: actions/configure-pages@v4
36+
id: page-setup
3937

4038
- name: Build with Jekyll
4139
run: |
4240
cd docs
43-
jekyll build --baseurl "${{ steps.page-setup.outputs.base_path }}"
41+
bundle exec jekyll build --baseurl "${{ steps.page-setup.outputs.base_path }}"
4442
env:
4543
JEKYLL_ENV: production
4644

@@ -59,4 +57,4 @@ jobs:
5957
steps:
6058
- name: Deploy to GitHub Pages
6159
id: deployment
62-
uses: actions/deploy-pages@v4
60+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,10 @@ instance/
6969
# Scrapy stuff:
7070
.scrapy
7171

72-
# Sphinx documentation
72+
# Documentation
7373
docs/_build/
74+
docs/_site/
75+
/site
7476

7577
# PyBuilder
7678
.pybuilder/
@@ -137,9 +139,6 @@ venv.bak/
137139
# Rope project settings
138140
.ropeproject
139141

140-
# mkdocs documentation
141-
/site
142-
143142
# mypy
144143
.mypy_cache/
145144
.dmypy.json
@@ -160,3 +159,4 @@ cython_debug/
160159
# and can be added to the global gitignore or merged into this file. For a more nuclear
161160
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
162161
#.idea/
162+

DOCUMENTATION_SETUP.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Edit `docs/_config.yml` to customize:
156156
# Site information
157157
title: "Alanube Python API Documentation"
158158
description: "Comprehensive documentation for the Alanube Python API client"
159-
url: "https://wilmerm.github.io/alanube-python-api"
159+
url: "https://wilmerm.github.io/alanube-python"
160160

161161
# Navigation
162162
nav:
@@ -167,8 +167,8 @@ nav:
167167

168168
# Social links
169169
social:
170-
github: wilmerm/alanube-python-api
171-
twitter: alanube_co
170+
github: wilmerm/alanube-python
171+
twitter: AlanubeRD
172172
```
173173
174174
## 🔧 Deployment
@@ -180,7 +180,7 @@ The documentation is automatically deployed via GitHub Actions:
180180
1. **Trigger:** Push to main/master branch
181181
2. **Build:** Jekyll builds the site
182182
3. **Deploy:** Site is deployed to GitHub Pages
183-
4. **URL:** https://wilmerm.github.io/alanube-python-api
183+
4. **URL:** https://wilmerm.github.io/alanube-python/
184184
185185
### Manual Deployment
186186
@@ -241,7 +241,7 @@ The site includes:
241241
```bash
242242
# Check Jekyll version
243243
jekyll --version
244-
244+
245245
# Clean and rebuild
246246
bundle exec jekyll clean
247247
bundle exec jekyll build
@@ -382,4 +382,4 @@ This documentation is licensed under the MIT License, same as the main project.
382382

383383
**The documentation is now ready to help users effectively use the Alanube Python API! 🚀**
384384

385-
For questions or improvements, please open an issue or submit a pull request.
385+
For questions or improvements, please open an issue or submit a pull request.

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ If you're contributing to the development of this library, here are the steps to
7373
1. Clone the repository:
7474

7575
```sh
76-
git clone https://github.com/wilmerm/alanube-python-api.git
77-
cd alanube-python-api
76+
git clone https://github.com/wilmerm/alanube-python.git
77+
cd alanube-python
7878
```
7979

8080
2. Create a virtual environment (optional but recommended):
@@ -147,15 +147,22 @@ To compile and upload the library to PyPI, follow these steps:
147147
## Credits
148148

149149
<table>
150-
<tr>
151-
<td align="center">
152-
<a href="https://github.com/wilmerm">
153-
<img src="https://github.com/wilmerm.png" width="100px;" alt="Wilmer Martinez"/><br />
154-
<sub><b>Wilmer Martinez</b></sub>
155-
</a>
156-
<br/>Author & Maintainer
157-
</td>
158-
</tr>
150+
<tr>
151+
<td align="center">
152+
<a href="https://github.com/wilmerm">
153+
<img src="https://github.com/wilmerm.png" width="100px;" alt="Wilmer Martinez"/><br />
154+
<sub><b>Wilmer Martinez</b></sub>
155+
</a>
156+
<br/>Author & Maintainer
157+
</td>
158+
<td align="center">
159+
<a href="https://github.com/Bamidele123456">
160+
<img src="https://github.com/Bamidele123456.png" width="100px;" alt="Oriku Precious"/><br />
161+
<sub><b>Oriku Precious</b></sub>
162+
</a>
163+
<br/>Documentation Contributor
164+
</td>
165+
</tr>
159166
</table>
160167

161168
If you contributed to this project and would like to be listed here, feel free to open a pull request adding yourself to the credits section.
@@ -175,9 +182,7 @@ We welcome pull requests and suggestions. Please open an issue or submit a PR.
175182

176183
## Support 💗
177184

178-
If you find this useful, consider supporting:
179-
180-
[Donate on PayPal](https://paypal.me/martinezwilmer?country.x=DO&locale.x=es_XC)
185+
If you find this useful, consider supporting.
181186

182187
Your generosity helps us to continue improving and maintaining this project. We appreciate every contribution, however small. Thanks for being part of our community!
183188

docs/_config.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
title: Alanube Python API Documentation
22
description: Comprehensive documentation for the Alanube Python API client
33
author: Alanube Team
4-
email: support@alanube.co
4+
email: soporte@alanube.co
55

66
# Site settings
7-
url: "https://wilmerm.github.io/alanube-python-api"
8-
baseurl: "/alanube-python-api"
7+
url: "https://wilmerm.github.io/alanube-python/"
8+
baseurl: "/alanube-python"
99

1010
# Build settings
1111
markdown: kramdown
@@ -50,18 +50,18 @@ nav:
5050
footer:
5151
links:
5252
- title: GitHub
53-
url: https://github.com/wilmerm/alanube-python-api
53+
url: https://github.com/wilmerm/alanube-python
5454
- title: PyPI
5555
url: https://pypi.org/project/alanube/
5656
- title: Issues
57-
url: https://github.com/wilmerm/alanube-python-api/issues
57+
url: https://github.com/wilmerm/alanube-python/issues
5858
- title: Alanube
5959
url: https://www.alanube.co/
6060

6161
# Social media
6262
social:
63-
github: wilmerm/alanube-python-api
64-
twitter: alanube_co
63+
github: wilmerm/alanube-python
64+
twitter: AlanubeRD
6565

6666
# Analytics (optional)
6767
# google_analytics: UA-XXXXXXXXX-X
@@ -82,4 +82,4 @@ exclude:
8282
- setup.cfg
8383
- MANIFEST.in
8484
- alanube/
85-
- .gitignore
85+
- .gitignore

0 commit comments

Comments
 (0)