search

cms-gem-daq-project / gem-plotting-tools

Repository for GEM commissioning plotting tools
GNU General Public License v3.0
1 stars 26 forks source link

Developer instructions #125

Closed lmoureaux closed 6 years ago

lmoureaux commented 6 years ago

Description

(On top of #123)

Add instructions for developers to the Sphinx documentation:

The concerns raised in #121 are also addressed in this PR.

Since Github has basic support for rendering rst, I could add a link to developer docs in the README. However, cross-references don't work, and the rendering is much worse than what Sphinx does.

Types of changes

Motivation and Context

We need to document how to set up a development area and test changes.

How Has This Been Tested?

The instructions are based on https://gist.github.com/jsturdy/4f9bccbdd18d953f73777e492a71fd24, my own experience as a developer and support I did privately on Mattermost.

Screenshots (if appropriate)

Better than a screenshot, a link to the documentation!

Checklist:

bdorney commented 6 years ago

Does this supersede https://github.com/cms-gem-daq-project/gem-plotting-tools/pull/123 or require https://github.com/cms-gem-daq-project/gem-plotting-tools/pull/123?

bdorney commented 6 years ago

Does this also superseded: https://github.com/cms-gem-daq-project/gem-plotting-tools/pull/121?

lmoureaux commented 6 years ago

No PR is superseded. This one (#125) is built on top of #123 since I expect #123 to be merged before (but it's not required and I can rebase off current develop). It also fixes the issue that prevents #121 from being merged (#121 will need a rebase).

lmoureaux commented 6 years ago
bdorney commented 6 years ago

This PR is out of date with develop. Can you update it? Then I'll approve it.

lmoureaux commented 6 years ago

Rebased.