Skip to content

Commit

Permalink
Updated files with 'repo_helper'. (#62)
Browse files Browse the repository at this point in the history
Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com>
  • Loading branch information
repo-helper[bot] authored May 16, 2021
1 parent c36c9f6 commit 27a18a1
Show file tree
Hide file tree
Showing 12 changed files with 35 additions and 26 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/flake8.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ jobs:
- name: "Run Flake8"
if: steps.changes.outputs.code == 'true'
run: "python -m tox -e lint -- --format github"
run: "python -m tox -e lint -s false -- --format github"
2 changes: 1 addition & 1 deletion .github/workflows/mypy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ jobs:
- name: "Run mypy"
if: steps.changes.outputs.code == 'true'
run: "python -m tox -e mypy"
run: "python -m tox -e mypy -s false"
2 changes: 1 addition & 1 deletion .github/workflows/python_ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ jobs:
- name: "Run Tests for Python ${{ matrix.config.python-version }}"
if: steps.setup-python.outcome == 'success'
run: python -m tox -e "${{ matrix.config.testenvs }}"
run: python -m tox -e "${{ matrix.config.testenvs }}" -s false

- name: "Upload Coverage 🚀"
uses: actions/upload-artifact@v2
Expand Down
3 changes: 1 addition & 2 deletions .github/workflows/python_ci_linux.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ jobs:
- name: "Run Tests for Python ${{ matrix.config.python-version }}"
if: steps.setup-python.outcome == 'success'
run: python -m tox -e "${{ matrix.config.testenvs }}"
run: python -m tox -e "${{ matrix.config.testenvs }}" -s false

- name: "Upload Coverage 🚀"
uses: actions/upload-artifact@v2
Expand Down Expand Up @@ -150,7 +150,6 @@ jobs:
skip_existing: true



Conda:
needs: deploy
runs-on: "ubuntu-20.04"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/python_ci_macos.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ jobs:
- name: "Run Tests for Python ${{ matrix.config.python-version }}"
if: steps.setup-python.outcome == 'success'
run: python -m tox -e "${{ matrix.config.testenvs }}"
run: python -m tox -e "${{ matrix.config.testenvs }}" -s false

- name: "Upload Coverage 🚀"
uses: actions/upload-artifact@v2
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ repos:
- id: forbid-crlf

- repo: /~https://github.com/repo-helper/formate
rev: v0.4.3
rev: v0.4.4
hooks:
- id: formate
exclude: ^(doc-source/conf|__pkginfo__|setup)\.(_)?py$
Expand Down
25 changes: 14 additions & 11 deletions doc-source/Source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,27 @@ and can be accessed from the following URL: /~https://github.com/domdfcoding/domdf

If you have ``git`` installed, you can clone the repository with the following command:

.. code-block:: bash
.. prompt:: bash

git clone /~https://github.com/domdfcoding/domdf_python_tools

.. parsed-literal::
$ git clone /~https://github.com/domdfcoding/domdf_python_tools"
> Cloning into 'domdf_python_tools'...
> remote: Enumerating objects: 47, done.
> remote: Counting objects: 100% (47/47), done.
> remote: Compressing objects: 100% (41/41), done.
> remote: Total 173 (delta 16), reused 17 (delta 6), pack-reused 126
> Receiving objects: 100% (173/173), 126.56 KiB | 678.00 KiB/s, done.
> Resolving deltas: 100% (66/66), done.
Cloning into 'domdf_python_tools'...
remote: Enumerating objects: 47, done.
remote: Counting objects: 100% (47/47), done.
remote: Compressing objects: 100% (41/41), done.
remote: Total 173 (delta 16), reused 17 (delta 6), pack-reused 126
Receiving objects: 100% (173/173), 126.56 KiB | 678.00 KiB/s, done.
Resolving deltas: 100% (66/66), done.
| Alternatively, the code can be downloaded in a 'zip' file by clicking:
| :guilabel:`Clone or download` --> :guilabel:`Download Zip`
.. figure:: git_download.png
:alt: Downloading a 'zip' file of the source code.
:alt: Downloading a 'zip' file of the source code.

Downloading a 'zip' file of the source code
Downloading a 'zip' file of the source code


Building from source
Expand Down
12 changes: 9 additions & 3 deletions doc-source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,15 @@
"exclude-members": ','.join(config["autodoc_exclude_members"]),
}

latex_elements = {
"fncychap": "\\usepackage[Bjarne]{fncychap}\n\\ChNameAsIs\n\\ChTitleAsIs\n",
}
latex_elements = {}


def setup(app):
# 3rd party
from sphinx_toolbox.latex import better_header_layout

app.connect("config-inited", lambda app, config: better_header_layout(config))


manpages_url = "https://manpages.debian.org/{path}"
toctree_plus_types.add("fixture")
2 changes: 1 addition & 1 deletion doc-source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,6 @@ Highlights

View the :ref:`Function Index <genindex>` or browse the `Source Code <_modules/index.html>`__.

`Browse the GitHub Repository </~https://github.com/domdfcoding/domdf_python_tools>`__
:github:repo:`Browse the GitHub Repository <domdfcoding/domdf_python_tools>`

.. end links
2 changes: 1 addition & 1 deletion doc-source/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ sphinx-notfound-page>=0.5
sphinx-prompt>=1.1.0
sphinx-pyproject>=0.1.0
sphinx-tabs>=1.1.13
sphinx-toolbox>=2.2.0
sphinx-toolbox>=2.10.0
sphinxcontrib-httpdomain>=1.7.0
sphinxemoji>=0.1.6
toctree-plus>=0.1.0
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ extensions = [
"sphinx_toolbox.more_autosummary",
"sphinx_toolbox.documentation_summary",
"sphinx_toolbox.tweaks.param_dash",
"sphinx_toolbox.tweaks.latex_layout",
"sphinx_toolbox.tweaks.latex_toc",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
Expand Down
6 changes: 3 additions & 3 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ pip_version = pip>=21
changedir = {toxinidir}/doc-source
extras = all
deps = -r{toxinidir}/doc-source/requirements.txt
commands = sphinx-build -M html . ./build {posargs}
commands = sphinx-build -M {env:SPHINX_BUILDER:html} . ./build {posargs}

[testenv:build]
skip_install = True
Expand All @@ -54,8 +54,8 @@ changedir = {toxinidir}
ignore_errors = True
skip_install = False
deps =
flake8 >=3.8.2
flake8-2020 >= 1.6.0
flake8>=3.8.2
flake8-2020>=1.6.0
flake8-builtins>=1.5.3
flake8-docstrings>=1.5.0
flake8-dunder-all>=0.1.1
Expand Down

0 comments on commit 27a18a1

Please sign in to comment.