Skip to content

Commit f109350

Browse files
committed
rebuilding docs
1 parent a7a314e commit f109350

File tree

5 files changed

+38
-4
lines changed

5 files changed

+38
-4
lines changed

.github/workflows/docs.yml

+15-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Build and Deploy Sphinx Documentation
33
on:
44
push:
55
branches:
6-
- main # ou le nom de votre branche principale
6+
- main # or your default branch
77

88
jobs:
99
build-and-deploy:
@@ -22,11 +22,24 @@ jobs:
2222
run: |
2323
python -m pip install --upgrade pip
2424
pip install sphinx sphinx_rtd_theme nbsphinx
25+
pip install .
26+
pip freeze
27+
28+
- name: Debug environment
29+
run: |
30+
pwd
31+
ls -R
32+
python -c "import pandalchemy; print(pandalchemy.__file__)"
33+
python -c "from pandalchemy import methods; print(methods.__file__)"
2534
2635
- name: Build Documentation
2736
run: |
2837
cd docs
29-
make html
38+
sphinx-build -b html . _build/html -v # Verbose output
39+
40+
- name: Check build output
41+
run: |
42+
ls -R docs/_build/html
3043
3144
- name: Deploy to GitHub Pages
3245
uses: peaceiris/actions-gh-pages@v3
File renamed without changes.

docs/api.rst

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
11
API Reference
22
=============
33

4+
Methods
5+
-------
6+
47
.. automodule:: pandalchemy.methods
58
:members:
69
:undoc-members:
7-
:show-inheritance:
10+
:show-inheritance:
11+
12+
Individual Functions
13+
--------------------
14+
15+
.. autofunction:: pandalchemy.methods.select
16+
.. autofunction:: pandalchemy.methods.where_
17+
.. autofunction:: pandalchemy.methods.group_by
18+
19+
# Add more functions as needed

docs/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
import os
1010
import sys
1111
sys.path.insert(0, os.path.abspath('..'))
12+
print("Python path:", sys.path)
1213

1314
project = 'pandalchemy'
1415
copyright = '2024, Essi Parent'

docs/index.rst

+9-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,12 @@ documentation for details.
1616
:caption: Contents:
1717

1818
api
19-
examples/basic-usage
19+
_examples/basic-usage
20+
21+
22+
Indices and tables
23+
==================
24+
25+
* :ref:`genindex`
26+
* :ref:`modindex`
27+
* :ref:`search`

0 commit comments

Comments
 (0)