Skip to content

Commit 714553c

Browse files
committed
chore: release v0.1.0
* Converts all .rst documentation files to Markdown (.md) for better readability and GitHub rendering (README, INSTALL, CONTRIBUTING, CHANGELOG). * Removes the Sphinx docs/ directory in favour of standalone Markdown files at the repository root. * Removes boilerplate license headers from GitHub Actions workflow files. * Updates .editorconfig, MANIFEST.in, pyproject.toml and scripts/tests.sh to reflect the new file layout. * Fixes doctest errors. Co-Authored-by: Pascal Repond <pascal.repond@rero.ch>
1 parent 4574302 commit 714553c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1170
-1993
lines changed

.editorconfig

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,6 @@ skip = .eggs
4242
# Needed for isort since version 4.3.10
4343
reverse_relative = true
4444

45-
# RST files (used by sphinx)
46-
[*.rst]
47-
indent_size = 4
48-
4945
# CSS, HTML, JS, JSON, YML, Typescript
5046
[*.{scss,css,html,js,json,yml,ts}]
5147
indent_size = 2

.github/workflows/continuous-integration-test.yml

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
# RERO Invenio Base
2-
# Copyright (C) 2025 RERO.
3-
#
4-
# This program is free software: you can redistribute it and/or modify
5-
# it under the terms of the GNU Affero General Public License as published by
6-
# the Free Software Foundation, version 3 of the License.
7-
#
8-
# This program is distributed in the hope that it will be useful,
9-
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10-
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11-
# GNU Affero General Public License for more details.
12-
#
13-
# You should have received a copy of the GNU Affero General Public License
14-
# along with this program. If not, see <http://www.gnu.org/licenses/>.
15-
161
name: CI
172
on: [push, pull_request, workflow_dispatch]
183

@@ -50,5 +35,6 @@ jobs:
5035
- name: Coveralls
5136
if: ${{ matrix.dependencies == 'dev' }}
5237
uses: coverallsapp/github-action@v2
38+
continue-on-error: true
5339
with:
54-
format: cobertura
40+
format: cobertura

.github/workflows/pypi-publish.yml

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
# RERO Invenio Thumbnails
2-
# Copyright (C) 2026 RERO.
3-
#
4-
# This program is free software: you can redistribute it and/or modify
5-
# it under the terms of the GNU Affero General Public License as published by
6-
# the Free Software Foundation, version 3 of the License.
7-
#
8-
# This program is distributed in the hope that it will be useful,
9-
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10-
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11-
# GNU Affero General Public License for more details.
12-
#
13-
# You should have received a copy of the GNU Affero General Public License
14-
# along with this program. If not, see <http://www.gnu.org/licenses/>.
15-
161
name: Publish
172

183
on:

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,6 @@ coverage.xml
5757
# Django stuff:
5858
*.log
5959

60-
# Sphinx documentation
61-
docs/_build/
62-
6360
# PyBuilder
6461
target/
6562

AUTHORS.rst

Lines changed: 0 additions & 13 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
## [v0.1.0](https://github.com/rero/rero-invenio-thumbnails/tree/v0.1.0) (2026-02-25)
4+
5+
Initial release

CHANGES.rst

Lines changed: 0 additions & 75 deletions
This file was deleted.
Lines changed: 44 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,108 @@
1-
Contributing
2-
============
1+
# Contributing
32

43
Contributions are welcome, and they are greatly appreciated! Every
54
little bit helps, and credit will always be given.
65

7-
Types of Contributions
8-
----------------------
6+
## Types of Contributions
97

10-
Report Bugs
11-
~~~~~~~~~~~
8+
### Report Bugs
129

13-
Report bugs at https://github.com/rero/rero-invenio-thumbnails/issues.
10+
Report bugs at <https://github.com/rero/rero-invenio-thumbnails/issues>.
1411

1512
If you are reporting a bug, please include:
1613

17-
* Your operating system name and version.
18-
* Any details about your local setup that might be helpful in troubleshooting.
19-
* Detailed steps to reproduce the bug.
14+
- Your operating system name and version.
15+
- Any details about your local setup that might be helpful in troubleshooting.
16+
- Detailed steps to reproduce the bug.
2017

21-
Fix Bugs
22-
~~~~~~~~
18+
### Fix Bugs
2319

2420
Look through the GitHub issues for bugs. Anything tagged with "bug"
2521
is open to whoever wants to implement it.
2622

27-
Implement Features
28-
~~~~~~~~~~~~~~~~~~
23+
### Implement Features
2924

3025
Look through the GitHub issues for features. Anything tagged with "feature"
3126
is open to whoever wants to implement it.
3227

33-
Write Documentation
34-
~~~~~~~~~~~~~~~~~~~
28+
### Write Documentation
3529

3630
rero-invenio-thumbnails could always use more documentation, whether as part of the
3731
official rero-invenio-thumbnails docs, in docstrings, or even on the web in blog posts,
3832
articles, and such.
3933

40-
Submit Feedback
41-
~~~~~~~~~~~~~~~
34+
### Submit Feedback
4235

4336
The best way to send feedback is to file an issue at
44-
https://github.com/rero/rero-invenio-thumbnails/issues.
37+
<https://github.com/rero/rero-invenio-thumbnails/issues>.
4538

4639
If you are proposing a feature:
4740

48-
* Explain in detail how it would work.
49-
* Keep the scope as narrow as possible, to make it easier to implement.
50-
* Remember that this is a volunteer-driven project, and that contributions
41+
- Explain in detail how it would work.
42+
- Keep the scope as narrow as possible, to make it easier to implement.
43+
- Remember that this is a volunteer-driven project, and that contributions
5144
are welcome :)
5245

53-
Get Started!
54-
------------
46+
## Get Started!
5547

5648
Ready to contribute? Here's how to set up `rero-invenio-thumbnails` for local development.
57-
The steps use the [`uv`](https://docs.astral.sh/uv/) tool but the equivalent with
49+
The steps use the [uv](https://docs.astral.sh/uv/) tool but the equivalent with
5850
pipenv or other tools is perfectly fine as well.
5951

6052
1. Fork the `rero/rero-invenio-thumbnails` repo on GitHub.
6153
2. Clone your fork locally:
6254

63-
.. code-block:: console
64-
65-
$ git clone git@github.com:your_name_here/rero-invenio-thumbnails.git
55+
```bash
56+
$ git clone git@github.com:your_name_here/rero-invenio-thumbnails.git
57+
```
6658

6759
3. Install your local copy into a virtualenv:
6860

69-
.. code-block:: console
70-
71-
$ cd rero-invenio-thumbnails/
72-
$ uv venv
73-
$ uv pip install -e .[all]
61+
```bash
62+
$ cd rero-invenio-thumbnails/
63+
$ uv venv
64+
$ uv pip install -e .[all]
65+
```
7466

7567
4. Create a branch for local development:
7668

77-
.. code-block:: console
78-
79-
$ git checkout -b name-of-your-bugfix-or-feature
69+
```bash
70+
$ git checkout -b name-of-your-bugfix-or-feature
71+
```
8072

8173
Now you can make your changes locally.
8274

8375
5. When you're done making changes, check that your changes pass tests:
8476

85-
.. code-block:: console
86-
87-
$ uv run ./run-tests.sh
77+
```bash
78+
$ uv run poe run_tests
79+
```
8880

8981
The tests will provide you with test coverage and also check PEP8
90-
(code style), PEP257 (documentation), flake8 as well as build the Sphinx
91-
documentation and run doctests.
82+
(code style), PEP257 (documentation), flake8 as well as run doctests.
9283

9384
6. Commit your changes and push your branch to GitHub:
9485

95-
.. code-block:: console
96-
97-
$ git add .
98-
$ git commit -s
99-
-m "component: title without verbs"
100-
-m "* NEW Adds your new feature."
101-
-m "* FIX Fixes an existing issue."
102-
-m "* BETTER Improves and existing feature."
103-
-m "* Changes something that should not be visible in release notes."
104-
$ git push origin name-of-your-bugfix-or-feature
86+
```bash
87+
$ git add .
88+
$ git commit -s \
89+
-m "component: title without verbs" \
90+
-m "* NEW Adds your new feature." \
91+
-m "* FIX Fixes an existing issue." \
92+
-m "* BETTER Improves and existing feature." \
93+
-m "* Changes something that should not be visible in release notes."
94+
$ git push origin name-of-your-bugfix-or-feature
95+
```
10596

10697
7. Submit a pull request through the GitHub website.
10798

108-
Pull Request Guidelines
109-
-----------------------
99+
## Pull Request Guidelines
110100

111101
Before you submit a pull request, check that it meets these guidelines:
112102

113103
1. The pull request should include tests and must not decrease test coverage.
114104
2. If the pull request adds functionality, the docs should be updated. Put
115105
your new functionality into a function with a docstring.
116106
3. The pull request should work for all Python versions currently supported by Invenio. Check
117-
https://github.com/rero/rero-invenio-thumbnails/actions?query=event%3Apull_request
107+
<https://github.com/rero/rero-invenio-thumbnails/actions?query=event%3Apull_request>
118108
and make sure that the tests pass for all supported Python versions.

0 commit comments

Comments
 (0)