Skip to content

Commit 002439e

Browse files
authored
docs: add changelog and contributing files (#23)
1 parent 294bd9a commit 002439e

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Changelog
2+

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing to the pyos-sphinx theme
2+
3+
We use nox to build our sphinx theme. For instructions on
4+
getting started with a local development workflow, see our
5+
[development page](https://www.pyopensci.org/pyos-sphinx-theme/develop.html).

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,27 @@
11
# ``pyos-sphinx-theme``
2+
23
[![Documentation Status](https://readthedocs.org/projects/pyos-sphinx-theme/badge/?version=latest)](https://pyos-sphinx-theme.readthedocs.io/en/latest/?badge=latest)
34
[![PyPI version](https://badge.fury.io/py/pyos-sphinx-theme.svg)](https://badge.fury.io/py/pyos-sphinx-theme)
45
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
56
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
67
<!-- ALL-CONTRIBUTORS-BADGE:END -->
78

8-
A modified version of the [PyData Sphinx Theme](github.com/pydata/sphinx-theme) for use with the [pyOpenSci](https://pyopensci.org) project.
9+
[![All Contributors](https://img.shields.io/github/all-contributors/pyOpenSci/pyos-sphinx-theme?color=ee8449)](#contributors-)
10+
11+
A modified version of the [PyData Sphinx Theme](github.com/pydata/sphinx-theme) that is used to keep the [pyOpenSci](https://pyopensci.org) organization repo books visually in sync.
912

1013
## Contributors
1114

1215
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
1316

17+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
18+
<!-- prettier-ignore-start -->
19+
<!-- markdownlint-disable -->
20+
21+
22+
<!-- markdownlint-restore -->
23+
<!-- prettier-ignore-end -->
24+
25+
<!-- ALL-CONTRIBUTORS-LIST:END -->
26+
1427
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)