Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation fixes and improvements #4146

Merged
merged 4 commits into from Jun 2, 2017

Conversation

Projects
None yet
4 participants
@nsoranzo
Copy link
Member

commented Jun 2, 2017

  • Update lib documentation
  • Simplify updaterst target in doc/Makefile
  • Fix some links and syntax errors in tool XML documentation
  • Document <hook> sub-element of <code>

nsoranzo added some commits Jun 1, 2017

Update lib documentation
Also simplify updaterst target in doc/Makefile

Partially revert commit b4feb85 : re-add
doc/source/lib/galaxy.webapps.galaxy.api.rst and
doc/source/lib/galaxy.webapps.tool_shed.api.rst and include them in
doc/source/api/api.rst and doc/source/api/ts_api.rst respectively to
simplify doc maintenance.
@martenson

This comment has been minimized.

Copy link
Member

commented Jun 2, 2017

You are reverting some of my changes I made to improve readability. The following screenshots illustrate this (imho) regression.

screenshot 2017-06-02 10 56 30
screenshot 2017-06-02 10 56 53

@dannon

This comment has been minimized.

Copy link
Member

commented Jun 2, 2017

@martenson Which is which, in the screenshots? I prefer the one on the right in both cases I think.

@martenson

This comment has been minimized.

Copy link
Member

commented Jun 2, 2017

@dannon left is this PR. Right is current dev.

@jmchilton

This comment has been minimized.

Copy link
Member

commented Jun 2, 2017

@nsoranzo I like that this PR is automating the update of those top level API pages - I think that is important. Maybe do it with a sed command instead of an include though so we can preserve the formatting that @dannon and @martenson prefer?

@nsoranzo

This comment has been minimized.

Copy link
Member Author

commented Jun 2, 2017

@martenson Yes, it says so in the commit message and I've requested your review for this reason. The problem is that the current version requires manual updating instead of the simple:

make -C doc/ updaterst

which is used to update the rest of the lib documentation. It also leaves missing docs in the lib documentation.

If that's considered important, I can create a sed script as suggested by @jmchilton.

@martenson

This comment has been minimized.

Copy link
Member

commented Jun 2, 2017

I prefer readability. It is not just that index page, bus also the actual contents:

screenshot 2017-06-02 11 21 07

Also the galaxy.webapps.galaxy.api package (and tool shed api) links in the left menu seem confusing.

@nsoranzo

This comment has been minimized.

Copy link
Member Author

commented Jun 2, 2017

@martenson @dannon I've the Makefile rules almost ready, is it OK for you to have annotations module, authenticate module, etc.
I slightly prefer them over just annotations, authenticate, etc...

@martenson

This comment has been minimized.

Copy link
Member

commented Jun 2, 2017

@nsoranzo that is fine I think, the biggest culprit there is the repeating prefix

@nsoranzo

This comment has been minimized.

Copy link
Member Author

commented Jun 2, 2017

@martenson Try now.

@martenson martenson merged commit 1fc12eb into galaxyproject:dev Jun 2, 2017

5 checks passed

api test Build finished. 276 tests run, 0 skipped, 0 failed.
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
framework test Build finished. 150 tests run, 0 skipped, 0 failed.
Details
integration test Build finished. 34 tests run, 0 skipped, 0 failed.
Details
toolshed test Build finished. 579 tests run, 0 skipped, 0 failed.
Details
@martenson

This comment has been minimized.

Copy link
Member

commented Jun 2, 2017

Thanks @nsoranzo !

@nsoranzo nsoranzo deleted the nsoranzo:doc_fixes branch Jun 5, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.