Commit Graph

16 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 f60d242137 Update to latest Sphinx for documentation
Roll forward to recent version of sphinx for documentation generation.

Change-Id: I9dadd6304cad15b58d39a1014c6804b4e32363ad
2017-04-11 18:03:20 +01:00
Paul Bourke 5de57e8b26 Add docs on how the import branch is named
Change-Id: I86020cb0a9a828953bca69fccea957682ae94696
2017-02-17 15:48:40 +00: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 e85a2bad98 Tidy up subcommands page title
Shorten subcommands page title by removing 'Git-Upstream '
to avoid line wrapping in sidebar display.

Change-Id: I6d742e846065c624579e567c1435c53b3946ae8c
2017-02-10 15:23:23 +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 1f10853f24 Support GitHub cross references using source files
Allow links to be specified to the source files, which will be
converted correctly by GitHub, by ensuring the sphinx generation then
transforms the link from the source file to the correct output file
depending on the builder used.

Change-Id: I18ac055fc6d44982048365cad819f891786484a8
2016-11-18 10:44:36 +00:00
Darragh Bailey 363a88bf22 Use sphinxcontrib-fulltoc
Change side bar toc to a full toc to show both global and local toc
simultaneously.

Change-Id: Ied595bab97bccb8cd942c2a0b35a429d7ee88bfb
Depends-On: I8dced20b036c267799b609a6fa719f6afde89a10
2016-11-16 15:19:41 +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
Jenkins 4e7c1fe0f9 Merge "Fix read-the-docs doc building" 2016-11-11 15:22:04 +00:00
Darragh Bailey e3867dcea4 Fix read-the-docs doc building
Read-the-docs requires the application module to be available via the
PYTHONPATH to build correctly as it does not install a virtualenv and
configuring it to do so results in it failing to find the custom
readthedocs sphinx builder.

Change-Id: Ic4a650fdbc8db1c8aeb7027121b3e0340d39b686
2016-11-11 12:54:58 +00:00
Darragh Bailey abb34a9a61 Fix docs build manpage on python3
Change-Id: I4142873e25ff6d311eb8c80a73a47b73861a61b8
2016-11-08 12:11:51 +00:00
Darragh Bailey 98b283ec37 Include files for sphinx based documentation
Change-Id: I5d6a30d986bc82cc22f0b095a000fe7e055fc588
2016-11-01 19:06:52 +00:00
Darragh Bailey b95b257fe1 Auto build and install default man page
Change-Id: I0b6c8442c98b11fd35b3851e7b31b8ebfa1c3785
2016-11-01 18:54:50 +00:00
Darragh Bailey ac76015552 Move build_manpage utility to doc area
Change-Id: I1f440d5be6eb7e14c8f8a5dfbcdcfcaa71ce1ef7
2016-11-01 13:03:03 +00:00