Skip to content

Commit

Permalink
docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexEngelhardt committed Dec 5, 2018
1 parent 02507ac commit 1a8471b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
6 changes: 5 additions & 1 deletion PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@

- Increase the version number in `__init__.py`
- Go into `doc/` and `make html` and `make latexpdf`
- `git commit`; `git push origin master`
- Git stuff:
- `git commit`
- `git push origin master`
- `git tag v0.4` (i.e. a new version)
- `git push origin v0.4` (this auto-creates a new *release*)
- Build the new docs at [readthedocs](https://readthedocs.org/projects/startup-name-generator/)
- Empty your `dist/` directory (not said in the tutorial, but just for good measure).
- `python3 setup.py sdist bdist_wheel`
Expand Down
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
startup-name-generator
======================

- `This package on PyPI <https://pypi.org/project/sng/>`_
- `This package on GitHub <https://github.com/AlexEngelhardt/startup-name-generator>`_

Summary
-------

Expand All @@ -11,12 +14,12 @@ which can be used as suggestions for naming things like companies or software.
Quickstart
----------

Check out the Jupyter Notebook(s) in ``doc/notebooks/``.
Check out the `Jupyter Notebook(s) in doc/notebooks/ <https://startup-name-generator.readthedocs.io/en/latest/notebooks/01_quickstart.html>`_.

Documentation
-------------

- The documentation is `available online <https://startup-name-generator.readthedocs.io/en/latespt/>`_
- The full documentation is `available online <https://startup-name-generator.readthedocs.io/en/latest/>`_
- I also gave a lightning talk presenting the basic idea, it's available `on Youtube <https://www.youtube.com/watch?v=1w3Q3CEldG0>`_.

Extended summary
Expand Down

0 comments on commit 1a8471b

Please sign in to comment.