Skip to content

Commit

Permalink
Fixup warnings in doc builds
Browse files Browse the repository at this point in the history
  • Loading branch information
plstcharles committed Oct 18, 2018
1 parent 264c9f0 commit 984ccb8
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
13 changes: 7 additions & 6 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,25 +38,26 @@ To set up `thelper` for local development:

1. Fork `thelper <https://github.com/plstcharles/thelper>`_
(look for the "Fork" button).

2. Clone your fork locally::

$ git clone [email protected]:your_name_here/thelper.git
$ git clone [email protected]:your_name_here/thelper.git

3. Create a branch for local development::

$ git checkout -b name-of-your-bugfix-or-feature
$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

4. When you're done making changes, run all the checks and doc builder with `tox <https://tox.readthedocs.io/en/latest/install.html>`_ via::

$ make test-all
$ make test-all

5. Commit your changes and push your branch to GitHub::

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

6. Submit a pull request through the GitHub website.

Expand Down
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ include .editorconfig
include AUTHORS.rst
include CHANGELOG.rst
include CONTRIBUTING.rst
include DOCUMENTATION.rst
include INSTALL.rst
include README.rst

Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ For installation instructions, refer to the `installation guide <https://github.
usage instructions, refer to the `user guide <https://github.com/plstcharles/thelper/blob/master/thelper_usage.txt>`_. Information about
the auto-generated documentation is available `here <https://github.com/plstcharles/thelper/blob/master/DOCUMENTATION.rst>`_.

=====

Notes
=====
-----

Development is still on-going --- expect the API and the internal classes to change rapidly.

Expand Down

0 comments on commit 984ccb8

Please sign in to comment.