Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove Sphinx Makefile and unpin Sphinx #744

Merged
merged 6 commits into from
Nov 26, 2023
Merged

Remove Sphinx Makefile and unpin Sphinx #744

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a706426
Unpin sphinx and remove Makefile
jhale Nov 24, 2023
037e242
Don't use makefile in web version.
jhale Nov 24, 2023
71e2967
Update pythonapp.yml
jhale Nov 24, 2023
b373089
Update README.md
jhale Nov 24, 2023
5886a2a
Update make_html.py
jhale Nov 24, 2023
571ace8
Merge branch 'main' into jhale/unfix-sphinx
garth-wells Nov 26, 2023
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
2 changes: 1 addition & 1 deletion .github/workflows/pythonapp.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ jobs:
cd doc/cpp
doxygen
cd ../python
make html
python -m sphinx -W -b html source build/html
- name: Upload C++ documentation artifact
uses: actions/upload-artifact@v3
with:
Expand Down
6 changes: 3 additions & 3 deletions doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ cd cpp
doxygen
```

The documentation will then be built in the folder `cpp/html/`.
The documentation will then be built in the folder `cpp/html`.


Python documentation
Expand All @@ -21,10 +21,10 @@ following commands:

```bash
cd python
make html
python -m sphinx -W -b html source/ build/html/
```

The documentation will then be built in the folder `python/html/`.
The documentation will then be built in the folder `python/build/html`.


Documentation for website
Expand Down
20 changes: 0 additions & 20 deletions doc/python/Makefile
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion doc/web/make_html.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,5 +267,5 @@ def system(command):
f.write(" demo/index")

# Make python docs
system(f"cd {path('python')} && make html")
system(f"cd {path('python')} && python3 -m sphinx -W -b html source/ build/html")
system(f"cp -r {path('python/build/html')} {path('html/python')}")
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ repository = "https://github.com/fenics/basix.git"
documentation = "https://docs.fenicsproject.org"

[project.optional-dependencies]
docs = ["markdown", "pylit3", "pyyaml", "sphinx==5.0.2", "sphinx_rtd_theme"]
docs = ["markdown", "pylit3", "pyyaml", "sphinx", "sphinx_rtd_theme"]
lint = ["flake8", "pydocstyle", "isort"]
optional = ["numba", "fenics-ufl@git+https://github.com/fenics/ufl"]
test = ["pytest", "sympy", "scipy", "matplotlib", "fenics-basix[optional]"]
Expand Down
Loading