Skip to content

Commit fdf2c02

Browse files
jklymakjklymak
authored
Merge pull request #2 from jklymak/tst-fix-ci
Dummy commit
2 parents d43b503 + 68c9160 commit fdf2c02

File tree

9 files changed

+123
-24
lines changed

9 files changed

+123
-24
lines changed

‎.circleci/config.yml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,17 @@
11
version: 2.1
22

33
orbs:
4-
python: circleci/python@0.2.1
4+
python: circleci/python@1.4.0
55

66
jobs:
7-
pip-install:
8-
executor: python/default
9-
steps:
10-
- checkout
11-
- run:
12-
name: install theme
13-
command: python -m pip install --user -ve .
147
build_docs:
158
executor: python/default
169
steps:
1710
- checkout
1811
- python/install-deps
12+
- run:
13+
name: install theme
14+
command: python -m pip install --user -ve .
1915
- run:
2016
name: Build docs
2117
command: cd docs/ && make html

‎.github/.github/workflows/lighthouse.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Lighthouse
2+
on: [push, pull_request]
3+
jobs:
4+
CI:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: actions/checkout@v1
8+
9+
- name: Set up Python 3.7
10+
uses: actions/setup-python@v1
11+
with:
12+
python-version: 3.7
13+
14+
- name: Install dask-sphinx-theme
15+
run: |
16+
python -m pip install --upgrade pip
17+
python -m pip install -e .
18+
19+
- name: Make example docs
20+
run: |
21+
cd docs
22+
make html
23+
24+
- name: Run Lighthouse against example docs build
25+
uses: treosh/lighthouse-ci-action@v2
26+
with:
27+
configPath: "./lighthouserc.json"
28+
temporaryPublicStorage: true

‎.github/.github/workflows/pre-commit.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Linting
2+
3+
on:
4+
push:
5+
branches: main
6+
pull_request:
7+
branches: main
8+
9+
jobs:
10+
checks:
11+
name: pre-commit hooks
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v2
15+
- uses: actions/setup-python@v2
16+
- uses: pre-commit/[email protected]

‎.github/.github/workflows/publish-pypi.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Push to PyPI
2+
3+
on:
4+
push:
5+
tags:
6+
- "*"
7+
8+
jobs:
9+
publish:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v1
15+
16+
- name: Set up Python 3.7
17+
uses: actions/setup-python@v1
18+
with:
19+
python-version: 3.7
20+
21+
- name: Install dask-sphinx-theme
22+
run: |
23+
python -m pip install --upgrade pip
24+
python -m pip install -e .
25+
26+
- name: Build dask-sphinx-theme dist
27+
run: |
28+
python -m pip install wheel twine
29+
python setup.py sdist bdist_wheel
30+
31+
- name: Publish dask-sphinx-theme
32+
uses: pypa/gh-action-pypi-publish@master
33+
with:
34+
user: __token__
35+
password: ${{ secrets.pypi_token }}

‎.github/.githubold/pull_request_template.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## PR Summary
2+
3+
4+
<!--
5+
To create a new package yml, make a new file with your package name in the `packages/`
6+
directory with a yml suffix. Examples can be seen in the `packages/` directory, but
7+
at the minimum you need to include the `repo:`, `section:` and `description:` fields.
8+
Please keep the description very short.
9+
10+
Other useful fields are `site:`, `pypi_name`, `conda_package`, (if different from the
11+
github name), and `conda_channel` if not *conda-forge*.
12+
-->

‎.github/.githubold/workflows/main.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
on: [status]
2+
jobs:
3+
circleci_artifacts_redirector_job:
4+
runs-on: ubuntu-latest
5+
name: Run CircleCI artifacts redirector
6+
steps:
7+
- name: GitHub Action step
8+
uses: larsoner/circleci-artifacts-redirector-action@master
9+
with:
10+
repo-token: ${{ secrets.GITHUB_TOKEN }}
11+
artifact-path: 0/docs/_build/html/index.html
12+
circleci-jobs: build_docs

‎README.rst

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,35 @@
1-
Dask Sphinx Theme
2-
=================
1+
Matplotlib Sphinx Theme
2+
=======================
33

4-
This is the official Sphinx theme for Dask documentation. It extends the
5-
``sphinx-book-theme`` project, but adds custom styling and a navigation bar to
6-
additional Dask subprojects.
4+
This is the official Sphinx theme for Matplotlib documentation. It extends the
5+
``pydata-sphinx-theme`` project, but adds custom styling and a navigation bar.
76

8-
When creating a Dask subproject you can include this theme by changing this
7+
When creating a Matplotlib subproject you can include this theme by changing this
98
line in your conf.py file
109

1110
.. code-block:: python
1211
13-
html_theme = 'dask_sphinx_theme'
12+
html_theme = 'mpl_sphinx_theme'
1413
15-
And by including ``dask_sphinx_theme`` as a requirement in your documentation
14+
And by including ``mpl_sphinx_theme`` as a requirement in your documentation
1615
installation.
1716

18-
Releasing
19-
---------
17+
Releasing [TODO]
18+
----------------
2019

21-
This project `uses GitHub Actions <https://github.com/dask/dask-sphinx-theme/blob/main/.github/workflows/publish-pypi.yml>`_
20+
This project `uses GitHub Actions <https://github.com/matplotlib/mpl-sphinx-theme/blob/main/.github/workflows/publish-pypi.yml>`_
2221
to automatically push a new release to PyPI whenever
2322
a git tag is pushed. For example, to release a new ``x.y.z`` version of
24-
``dask-sphinx-theme``, checkout the commit you would like to release,
23+
``mpl-sphinx-theme``, checkout the commit you would like to release,
2524
add a git tag, and push the tag to the ``main`` branch of the
26-
``dask/dask-sphinx-theme`` repository:
25+
``matplotlib/mpl-sphinx-theme`` repository:
2726

2827
.. code-block::
2928
3029
$ git checkout <commit-hash>
3130
$ git tag -a x.y.z -m 'Version x.y.z'
3231
$ git push upstream main --tags
3332
34-
After a new release is published on PyPI, a pull request to the ``dask-sphinx-theme``
35-
`conda-forge feedstock <https://github.com/conda-forge/dask-sphinx-theme-feedstock>`_
33+
After a new release is published on PyPI, a pull request to the ``mpl-sphinx-theme``
34+
`conda-forge feedstock <https://github.com/conda-forge/mpl-sphinx-theme-feedstock>`_
3635
for the new ``x.y.z`` release will automatically be opened by conda-forge bots.

‎docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ installation.
2121

2222
Note that the theme does not currently install the `logo2.svg` or
2323
the `favicon.ico`. You shoudl copy those from `docs/_static` to
24-
the local project `docs/_static`.
24+
the local project `docs/_static`.
2525

2626
The full ``conf.py`` is
2727

‎docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pydata-sphinx-theme>=0.6.0

0 commit comments

Comments
 (0)