-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #23 from UDST/dev
Finalizing v0.1.6 release
- Loading branch information
Showing
20 changed files
with
209 additions
and
269 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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
[run] | ||
omit = | ||
osmnet/**/tests/* | ||
osmnet/tests/* | ||
*/__init__.py |
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 |
---|---|---|
@@ -1,12 +1,56 @@ | ||
#### If you have found an error: | ||
## If you have found an error: | ||
|
||
- check the error message and [documentation](https://udst.github.io/osmnet/index.html) | ||
- search the previously opened and closed issues to see if the problem has already been reported | ||
- if the problem is with a dependency of OSMnet, please open an issue on the dependency's repo | ||
- if the problem is with OSMnet and you think you may have a fix, please submit a PR, otherwise please open an issue in the [issue tracker](https://github.com/UDST/osmnet/issues) following the issue template | ||
|
||
#### Making a feature proposal or contributing code: | ||
## Making a feature proposal or contributing code: | ||
|
||
- post your requested feature on the [issue tracker](https://github.com/UDST/osmnet/issues) and mark it with a `New feature` label so it can be reviewed | ||
- fork the repo, make your change (your code should attempt to conform to OSMnet's existing coding, commenting, and docstring styles), add new or update [unit tests](https://github.com/UDST/osmnet/tree/master/osmnet/tests), and submit a PR | ||
- respond to the code review | ||
## Updating the documentation: | ||
|
||
- See instructions in `docs/README.md` | ||
|
||
|
||
## Preparing a release: | ||
|
||
- Make a new branch for release prep | ||
|
||
- Update the version number and changelog | ||
- `CHANGELOG.md` | ||
- `setup.py` | ||
- `osmnet/__init__.py` | ||
- `docs/source/index.rst` | ||
|
||
- Make sure all the tests are passing, and check if updates are needed to `README.md` or to the documentation | ||
|
||
- Open a pull request to the master branch to finalize it | ||
|
||
- After merging, tag the release on GitHub and follow the distribution procedures below | ||
|
||
|
||
## Distributing a release on PyPI (for pip installation): | ||
|
||
- Register an account at https://pypi.org, ask one of the current maintainers to add you to the project, and `pip install twine` | ||
|
||
- Check out the copy of the code you'd like to release | ||
|
||
- Run `python setup.py sdist bdist_wheel --universal` | ||
|
||
- This should create a `dist` directory containing two package files -- delete any old ones before the next step | ||
|
||
- Run `twine upload dist/*` -- this will prompt you for your pypi.org credentials | ||
|
||
- Check https://pypi.org/project/osmnet/ for the new version | ||
|
||
|
||
## Distributing a release on Conda Forge (for conda installation): | ||
|
||
- The [conda-forge/osmnet-feedstock](https://github.com/conda-forge/osmnet-feedstock) repository controls the Conda Forge release | ||
|
||
- Conda Forge bots usually detect new releases on PyPI and set in motion the appropriate feedstock updates, which a current maintainer will need to approve and merge | ||
|
||
- Check https://anaconda.org/conda-forge/osmnet for the new version (may take a few minutes for it to appear) |
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# files to include in the source distribution on pypi (setup and README are included automatically) | ||
|
||
include HISTORY.rst | ||
include CHANGELOG.rst | ||
include LICENSE.txt |
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 was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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,31 @@ | ||
This folder generates the OSMNet online documentation, hosted at https://udst.github.io/osmnet/. | ||
|
||
### How it works | ||
|
||
HTML files are generated using [Sphinx](http://sphinx-doc.org) and hosted with GitHub Pages from the `gh-pages` branch of the repository. The online documentation is rendered and updated **manually**. | ||
|
||
### Editing the documentation | ||
|
||
The files in `docs/source`, along with docstrings in the source code, determine what appears in the rendered documentation. Here's a [good tutorial](https://pythonhosted.org/an_example_pypi_project/sphinx.html) for Sphinx. | ||
|
||
### Previewing changes locally | ||
|
||
Install the copy of OSMNet that the documentation is meant to reflect. Install the documentation tools. | ||
|
||
``` | ||
pip install . | ||
pip install sphinx sphinx_rtd_theme numpydoc | ||
``` | ||
|
||
Build the documentation. There should be status messages and warnings, but no errors. | ||
|
||
``` | ||
cd docs | ||
sphinx-build -b html source build | ||
``` | ||
|
||
The HTML files will show up in `docs/build/`. | ||
|
||
### Uploading changes | ||
|
||
Clone a second copy of the repository and check out the `gh-pages` branch. Copy over the updated HTML files, commit them, and push the changes to GitHub. |
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 @@ | ||
*/* |
This file was deleted.
Oops, something went wrong.
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
Oops, something went wrong.