Skip to content

Commit

Permalink
📚 update documentation and build scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
chfw committed Nov 23, 2024
1 parent dc74fa4 commit f9cb7ec
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 17 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/moban-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,22 @@ jobs:
- uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
token: ${{ secrets.PAT }}
- name: Set up Python
uses: actions/setup-python@v1
with:
python-version: '3.7'
- name: check changes
run: |
pip install markupsafe==2.0.1
pip install moban gitfs2 pypifs moban-jinja2-github moban-ansible
moban
git status
git diff --exit-code
- name: Auto-commit
if: failure()
uses: docker://cdssnc/auto-commit-github-action
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
uses: stefanzweifel/git-auto-commit-action@v4
with:
args: >-
commit_message: >-
This is an auto-commit, updating project meta data,
such as changelog.rst, contributors.rst
19 changes: 12 additions & 7 deletions .github/workflows/pythonpublish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,16 @@ on:
types: [created]

jobs:
deploy:
pypi-publish:
name: upload release to PyPI
runs-on: ubuntu-latest
# Specifying a GitHub environment is optional, but strongly encouraged
environment: pypi
permissions:
# IMPORTANT: this permission is mandatory for trusted publishing
id-token: write
steps:
# retrieve your distributions here
- uses: actions/checkout@v1
- name: Set up Python
uses: actions/setup-python@v1
Expand All @@ -16,11 +23,9 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel twine
- name: Build and publish
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
pip install setuptools wheel
- name: Build
run: |
python setup.py sdist bdist_wheel
twine upload dist/*
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
3 changes: 2 additions & 1 deletion CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@


2 contributors
3 contributors
================================================================================

In alphabetical order:

* `Ayan Banerjee <https://github.com/ayan-b>`_
* `Matěj Cepl <https://github.com/mcepl>`_
* `pgajdos <https://github.com/pgajdos>`_
4 changes: 1 addition & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@
lml - Load me later. A lazy plugin management system.
================================================================================

.. image:: https://api.travis-ci.org/python-lml/lml.svg
:target: http://travis-ci.org/python-lml/lml

.. image:: https://codecov.io/github/python-lml/lml/coverage.png
:target: https://codecov.io/github/python-lml/lml
.. image:: https://badge.fury.io/py/lml.svg
:target: https://pypi.org/project/lml

.. image:: https://pepy.tech/badge/lml/month
:target: https://pepy.tech/project/lml/month
:target: https://pepy.tech/project/lml

.. image:: https://img.shields.io/github/stars/python-lml/lml.svg?style=social&maxAge=3600&label=Star
:target: https://github.com/python-lml/lml/stargazers
Expand Down
5 changes: 3 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand All @@ -68,7 +68,8 @@
# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/3/': None}
intersphinx_mapping = {'python': ('https://docs.python.org/3',
'python-inv.txt')}
# TODO: html_theme not configurable upstream
html_theme = 'default'

Expand Down

0 comments on commit f9cb7ec

Please sign in to comment.