Skip to content

Commit

Permalink
Fix docs by upgrading sphinx and add Makefile entry
Browse files Browse the repository at this point in the history
  • Loading branch information
mmoriniere committed Apr 26, 2023
1 parent 33d8811 commit a6bf6b8
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ build
dist
__pycache__/
*.py[cod]
docs/_build
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,6 @@ styles.check:
black . --check
isort chopper --check-only
flake8 --config setup.cfg

doc:
(cd docs; make html)
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
|axe| Chopper
=============

|pypi| ![github actions badge](https://github.com/jurismarches/chopper/actions/workflows/ci.yml/badge.svg)
|pypi| |github-actions| |readthedocs|

Chopper is a tool to extract elements from HTML by preserving ancestors and CSS rules.

Expand Down Expand Up @@ -82,7 +82,7 @@ The result is :
.. |axe| image:: http://icons.iconarchive.com/icons/aha-soft/desktop-halloween/32/Hatchet-icon.png
.. |pypi| image:: http://img.shields.io/pypi/v/chopper.svg?style=flat
:target: https://pypi.python.org/pypi/chopper
.. |travis| image:: http://img.shields.io/travis/jurismarches/chopper/master.svg?style=flat
:target: https://travis-ci.org/jurismarches/chopper
.. |coveralls| image:: http://img.shields.io/coveralls/jurismarches/chopper/master.svg?style=flat
:target: https://coveralls.io/r/jurismarches/chopper
.. |github-actions| image:: https://github.com/jurismarches/chopper/actions/workflows/ci.yml/badge.svg
:target: https://github.com/jurismarches/chopper/actions/
.. |readthedocs| image:: https://readthedocs.org/projects/chopper/badge/?version=latest
:target: https://readthedocs.org/projects/chopper
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.

# Dev requirements
Sphinx==1.2.2
Sphinx>=6.2.0
sphinx-rtd-theme
pytest
pytest-cov
Expand Down

0 comments on commit a6bf6b8

Please sign in to comment.