diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 118cbabe..b983fbba 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -28,7 +28,7 @@ jobs: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@v2 - - uses: actions/setup-python@v5 + - uses: actions/setup-python@v2 with: python-version: ${{ matrix.python-versions }} @@ -40,10 +40,4 @@ jobs: - name: build documentation run: | poetry install -E dev - poetry run mkdocs gh-deploy - - # - name: publish documentation - # uses: peaceiris/actions-gh-pages@v3 - # with: - # personal_token: ${{ secrets.PERSONAL_TOKEN }} - # publish_dir: /site + poetry run mkdocs gh-deploy --config-file mkdocs.yml diff --git a/docs/index.md b/docs/index.md index 96916dc2..925533ac 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,51 +1,3 @@ -# Cookiecutter PyPackage - -Cookiecutter template for a Python package, built with popular develop tools and -conform to best practice. - -[![CI Status](https://github.com/EuanMason/cookiecutter-pypackage/actions/workflows/dev.yml/badge.svg)](https://github.com/EuanMason/cookiecutter-pypackage/actions/workflows/dev.yml) -[![License](https://img.shields.io/pypi/l/ppw)](https://opensource.org/licenses/BSD-2-Clause) - -* Documentation: - -## Features - -This tool will create Python project with the following features: - -* [Poetry](https://python-poetry.org/): Manage dependency, build and release -* [Mkdocs](https://www.mkdocs.org): Writing your docs in markdown style -* Testing with [Pytest](https://pytest.org) (unittest is still supported out of the box) -* Code coverage report and endorsed by [Codecov](https://codecov.io) -* [Tox](https://tox.readthedocs.io): Test your code against environment matrix, lint and artifact check -* Format with [Black](https://github.com/psf/black) and [Isort](https://github.com/PyCQA/isort) -* Lint code with [Flake8](https://flake8.pycqa.org) and [Flake8-docstrings](https://pypi.org/project/flake8-docstrings/) -* Check static type with [Mypy](http://mypy-lang.org/) (optional) -* [Pre-commit hooks](https://pre-commit.com/): Formatting/linting anytime when commit your code -* [Mkdocstrings](https://mkdocstrings.github.io/): Auto API doc generation -* Command line interface using [Click](https://click.palletsprojects.com/en/8.0.x/) (optional) -* [bump2version](https://github.com/c4urself/bump2version): Pre-configured version bumping with a single command -* Continuous Integration/Deployment by [GitHub actions](https://github.com/features/actions), includes: - * publish dev build/official release to TestPyPI/PyPI automatically when CI success - * publish documents automatically when CI success - * extract changelog from CHANGELOG and integrate with release notes automatically -* Host your documentation from [GitHub Pages](https://pages.github.com) with zero-config - -## Quickstart - -Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher): - -``` -pip install -U cookiecutter -``` - -Generate a Python package project: - -``` -cookiecutter https://github.com/EuanMason/cookiecutter-pypackage.git -``` - -Then follow **[Tutorial](docs/tutorial.md)** to finish other configurations. - -# Credits - -This repo is forked from [waynerv/cookiecutter-pypackage](https://github.com/waynerv/cookiecutter-pypackage), which is forked from [zillionare/python-project-wizard](https://github.com/zillionare/python-project-wizard), which originally forked from [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) +{% + include-markdown "../README.md" +%} diff --git a/pyproject.toml b/pyproject.toml index 5c765a85..9cc0043f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -64,5 +64,5 @@ exclude = ''' ''' [build-system] -requires = ["poetry-core>=1.0.0"] +requires = ["poetry-core"] build-backend = "poetry.core.masonry.api"