-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC: Add "Contributing" and "Version History" sections
- Loading branch information
Showing
6 changed files
with
83 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
Contributing | ||
============ | ||
|
||
If you find bugs, errors, omissions or other things that need improvement, | ||
please create an issue or a pull request at | ||
https://github.com/mgeier/insipid-sphinx-theme/. | ||
Contributions are always welcome! | ||
|
||
|
||
Development Installation | ||
------------------------ | ||
|
||
Instead of pip-installing the latest release from PyPI_, you should get the | ||
newest development version (a.k.a. "master") from Github_:: | ||
|
||
git clone https://github.com/mgeier/insipid-sphinx-theme.git --recursive | ||
cd insipid-sphinx-theme | ||
python3 -m pip install -e . --user | ||
|
||
... where ``-e`` stands for ``--editable``. | ||
|
||
When installing this way, you can quickly try other Git | ||
branches (in this example the branch is called "another-branch"):: | ||
|
||
git checkout another-branch | ||
|
||
If you want to go back to the "master" branch, use:: | ||
|
||
git checkout master | ||
|
||
To get the latest changes from Github, use:: | ||
|
||
git pull --ff-only | ||
|
||
If you used the ``--recursive`` option when cloning, | ||
the ``Font-Awesome`` submodule (containing the SVG icons) | ||
will be checked out automatically. | ||
If not, you can get the submodule with:: | ||
|
||
git submodule update --init | ||
|
||
.. _PyPI: https://pypi.org/project/insipid-sphinx-theme/ | ||
.. _Github: https://github.com/mgeier/insipid-sphinx-theme/ | ||
|
||
|
||
Building the Documentation | ||
-------------------------- | ||
|
||
If you make changes to the documentation, you should create the HTML | ||
pages locally using Sphinx and check if they look OK. | ||
|
||
Initially, you might need to install a few packages that are needed to build the | ||
documentation:: | ||
|
||
python3 -m pip install -r doc/requirements.txt --user | ||
|
||
To (re-)build the HTML files, use:: | ||
|
||
python3 setup.py build_sphinx | ||
|
||
The generated files will be available in the directory ``build/sphinx/html/``. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Version 0.1.0 (2020-08-05): | ||
Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. include:: ../CONTRIBUTING.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Version History | ||
=============== | ||
|
||
.. include:: ../NEWS.rst |