Commit Graph

6 Commits

Author SHA1 Message Date
melissaml e0289362b8 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: Iedb00886e132326e1c3617893d2898d97dc70d03
2018-04-21 04:47:05 +08:00
Darragh Bailey b23fcdf571 Clean up basic inaccuracies in documentation
Correct various mistakes in documentation and remove unnecessary
paragraphs.

Change-Id: Ia16095c88e7873bd815791a32ae3e93ed4ac6d54
2017-02-10 15:38:33 +00:00
Darragh Bailey dd9c80d3fe Update README and better divide inclusion into main docs
* Clean up README
* Add some info for developers/unit tests/support to README for GitHub
* Split up inclusion of contents from README

Change-Id: I91abfedce06827d5111370750c55384d7aff1a8e
2017-02-02 10:35:09 +00:00
Darragh Bailey 4af052ae8f Modify README to allow partial include
Change README to follow similar sections to allow partial inclusion of
pieces into sphinx generated docs to prevent duplication of same
information in multiple places.

Change-Id: I834d4dcf5d9e0bede3840812eb12e1d670421cc5
2016-11-15 15:34:42 +00:00
Darragh Bailey 65cb8e2004 Add basic documentation and migrate README & USAGE
Where documentation is being moved about, corrections will be avoided
to allow for easier following of conversion separated from rewriting.

* Set up some simple documentation to describe basic details of
  git-upstream and installation.
* Migrate details from README into dedicated subcommands rst doc.
* Consolidate installation instructions from USAGE into
  installation rst page.
* Move remainder of USAGE into dedicated workflows rst and match the
  existing markdown layout.

Change-Id: Ie73d64ae7cb0e96060729638da382c901d5d68e7
2016-11-14 15:18:54 +00:00
Darragh Bailey 360d839abe Switch to ReSTructured text from markdown
Change-Id: I94a16df2a766b36c690c0af948f00a714e047bd9
2016-11-11 15:24:07 +00:00