Skip to content

Commit

Permalink
DOC: Add "Contributing" and "Version History" sections
Browse files Browse the repository at this point in the history
  • Loading branch information
mgeier committed Aug 18, 2020
1 parent adb20d1 commit 7fcac95
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 7 deletions.
61 changes: 61 additions & 0 deletions CONTRIBUTING.rst
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/``.
2 changes: 2 additions & 0 deletions NEWS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Version 0.1.0 (2020-08-05):
Initial release
1 change: 1 addition & 0 deletions doc/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../CONTRIBUTING.rst
2 changes: 2 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
usage
configuration
customization
contributing
version-history

Git Repository <https://github.com/mgeier/insipid-sphinx-theme/>

Expand Down
20 changes: 13 additions & 7 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,20 @@ Installation and Usage

python3 -m pip install insipid-sphinx-theme --user

If the command ``python3`` isn't available, you can try ``python`` instead.
If you want to install the theme for all users
Depending on your Python installation,
you may have to use ``python`` instead of ``python3``.
If you want to install the module system-wide for all users
(assuming you have the necessary rights),
you can drop the ``--user`` flag.
If you are using a virtual environment, you might also have to drop the
``--user`` flag.
If you want to upgrade an existing installation, you can add the
``--upgrade`` flag.
you should drop the ``--user`` flag.
If you are using a `virtual environment`_,
you should also drop the ``--user`` flag
(otherwise you'll get an error like
``ERROR: Can not perform a '--user' install.
User site-packages are not visible in this virtualenv.``).
If you have installed the module already,
you can use the ``--upgrade`` flag to get the newest release.
.. _`virtual environment`: https://docs.python.org/3/tutorial/venv.html

#. Edit the :file:`conf.py` file
(just create an empty file if it doesn't exist yet,
Expand Down
4 changes: 4 additions & 0 deletions doc/version-history.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Version History
===============

.. include:: ../NEWS.rst

0 comments on commit 7fcac95

Please sign in to comment.