Skip to content

Commit

Permalink
fix documentation and badges
Browse files Browse the repository at this point in the history
  • Loading branch information
shtalinberg committed Nov 20, 2024
1 parent 45a923f commit e65934b
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 13 deletions.
42 changes: 38 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ doc: develop $(DOC_INDEX)

clean:
pip uninstall django-el-pagination -y || true
rm -rfv .coverage build/ dist/ doc/_build MANIFEST *.egg-info
rm -rf .coverage build/ dist/ doc/_build MANIFEST *.egg-info
find . -name '*.pyc' -delete
find . -name '__pycache__' -type d -delete

Expand All @@ -49,9 +49,6 @@ lint: develop
opendoc: doc
@firefox $(DOC_INDEX)

release: clean
python setup.py register sdist upload

server: develop
@$(WITH_VENV) $(MANAGE) runserver 0.0.0.0:8000

Expand All @@ -64,6 +61,43 @@ source:
test: develop
@$(WITH_VENV) $(MANAGE) test

build-dist: clean develop
@echo "Installing build dependencies..."
$(VENV)/bin/pip install build twine
@echo "Building distribution..."
$(VENV)/bin/python -m build

check-dist: build-dist
@echo "Checking distribution..."
$(VENV)/bin/twine check dist/*

upload-dist: check-dist
@echo "Uploading to PyPI..."
$(VENV)/bin/twine upload dist/*

release: clean develop
@echo "Starting release process..."
@if [ -z "$$SKIP_CONFIRMATION" ]; then \
read -p "Are you sure you want to release to PyPI? [y/N] " confirm; \
if [ "$$confirm" != "y" ]; then \
echo "Release cancelled."; \
exit 1; \
fi \
fi
$(MAKE) build-dist
$(MAKE) check-dist
@echo "Ready to upload to PyPI..."
@if [ -z "$$SKIP_CONFIRMATION" ]; then \
read -p "Proceed with upload? [y/N] " confirm; \
if [ "$$confirm" != "y" ]; then \
echo "Upload cancelled."; \
exit 1; \
fi \
fi
$(MAKE) upload-dist
@echo "Release completed successfully!"


help:
@echo 'Django Endless Pagination - Available commands:'
@echo
Expand Down
19 changes: 10 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Django EL(Endless) Pagination
=============================

| |pypi-pkg-version| |python-versions| |django-versions| |pypi-status| |docs|
| |build-ci-status| |build-ci-dev-status| |codecov|
| |build-ci-status| |tox-ci-status| |codecov|
Django EL(Endless) Pagination can be used to provide Twitter-style or
Digg-style pagination, with optional Ajax support and other features
Expand Down Expand Up @@ -32,11 +32,12 @@ https://github.com/shtalinberg/django-el-pagination.
Pull requests are welcome. See `Contributing Guide
<http://django-el-pagination.readthedocs.io/en/latest/contributing.html>`_.

.. |build-ci-status| image:: https://github.com/shtalinberg/django-el-pagination/actions/workflows/tests.yml/badge.svg?branch=master
:target: https://github.com/shtalinberg/django-el-pagination/actions/workflows/tests.yml
:alt: Build status
.. |docs| image:: https://readthedocs.org/projects/django-el-pagination/badge/?version=latest&style=flat
:target: https://django-el-pagination.readthedocs.io/
.. |build-ci-status| image:: https://github.com/shtalinberg/django-el-pagination/actions/workflows/tox.yml/badge.svg?branch=master
:target: https://github.com/shtalinberg/django-el-pagination/actions/workflows/tox.yml
:alt: Build release status
.. |docs| image:: https://readthedocs.org/projects/django-el-pagination/badge/?version=latest
:target: https://django-el-pagination.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |pypi-pkg-version| image:: https://img.shields.io/pypi/v/django-el-pagination.svg
:target: https://pypi.python.org/pypi/django-el-pagination/
.. |pypi-status| image:: https://img.shields.io/pypi/status/coverage.svg
Expand All @@ -46,6 +47,6 @@ Pull requests are welcome. See `Contributing Guide
.. |codecov| image:: https://codecov.io/gh/shtalinberg/django-el-pagination/branch/master/graph/badge.svg
:target: https://codecov.io/gh/shtalinberg/django-el-pagination
:alt: Code coverage
.. |build-ci-dev-status| image:: https://github.com/shtalinberg/django-el-pagination/actions/workflows/tests.yml/badge.svg?branch=develop
:target: https://github.com/shtalinberg/django-el-pagination/actions/workflows/tests.yml
:alt: Build dev status
.. |tox-ci-status| image:: https://github.com/shtalinberg/django-el-pagination/actions/workflows/tox.yml/badge.svg?branch=develop
:target: https://github.com/shtalinberg/django-el-pagination/actions/workflows/tox.yml
:alt: Tox develop status

0 comments on commit e65934b

Please sign in to comment.