Ticket #6783 (closed: fixed)
Add simpleapi documentation to Python sphinx output
| Reported by: | Martyn Gigg | Owned by: | Martyn Gigg |
|---|---|---|---|
| Priority: | critical | Milestone: | Release 2.5 |
| Component: | Mantid | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Wenduo Zhou |
Description
The simpleapi functions are not currently documented at all in the sphinx output and they should be.
Change History
comment:2 Changed 8 years ago by Martyn Gigg
Generate contents page correctly and remove gloassary. Refs #6783
Changeset: 664c93888c5f79a4a6ab22262eaa87e705e099c9
comment:3 Changed 8 years ago by Martyn Gigg
Add simpleapi to sphinx docs. Refs #6783
Required some minor changes to the way the doc strings were formatted.
Changeset: f08ee8b3bc5f2977b2c53d5c3f11ba37939c6305
comment:4 Changed 8 years ago by Martyn Gigg
Generate contents page correctly and remove gloassary. Refs #6783
Changeset: 664c93888c5f79a4a6ab22262eaa87e705e099c9
comment:6 Changed 8 years ago by Martyn Gigg
- Status changed from accepted to verify
- Resolution set to fixed
Branch: feature/6783_simpleapi_sphinx
Tester: To build this locally you must have python sphinx installed.
- Run cmake, checking that sphinx was found
- Type make sphinx-html, this will start MantidPlot to generate the docs
- cd ${BuildDir}/sphinx/html
- Run python -m SimpleHTTPServer and point your web browser at http://localhost:8000. (You could just open the index.html directly in the browser from your hdd but some browsers, Chrome for example, disable loading ajax directly from the local machine and this breaks the search functionality).
Things to check:
- Make sure all of the links work
- The contents page should list a page for each algorithm
- The search box should find what you expected for algorithms & other functions.
comment:7 Changed 8 years ago by Wenduo Zhou
- Status changed from verify to verifying
- Tester set to Wenduo Zhou
comment:9 Changed 8 years ago by Martyn Gigg
Add simpleapi to sphinx docs. Refs #6783
Required some minor changes to the way the doc strings were formatted.
Changeset: f08ee8b3bc5f2977b2c53d5c3f11ba37939c6305
comment:10 Changed 8 years ago by Martyn Gigg
Generate contents page correctly and remove gloassary. Refs #6783
Changeset: 664c93888c5f79a4a6ab22262eaa87e705e099c9
comment:11 Changed 8 years ago by Martyn Gigg
Add simpleapi to sphinx docs. Refs #6783
Required some minor changes to the way the doc strings were formatted.
Changeset: f08ee8b3bc5f2977b2c53d5c3f11ba37939c6305
comment:12 Changed 8 years ago by Martyn Gigg
Generate contents page correctly and remove gloassary. Refs #6783
Changeset: 664c93888c5f79a4a6ab22262eaa87e705e099c9
comment:13 Changed 7 years ago by Martyn Gigg
Add simpleapi to sphinx docs. Refs #6783
Required some minor changes to the way the doc strings were formatted.
Changeset: f08ee8b3bc5f2977b2c53d5c3f11ba37939c6305
comment:14 Changed 7 years ago by Martyn Gigg
Generate contents page correctly and remove gloassary. Refs #6783
Changeset: 664c93888c5f79a4a6ab22262eaa87e705e099c9
comment:15 Changed 7 years ago by Martyn Gigg
Add simpleapi to sphinx docs. Refs #6783
Required some minor changes to the way the doc strings were formatted.
Changeset: f08ee8b3bc5f2977b2c53d5c3f11ba37939c6305
comment:16 Changed 7 years ago by Martyn Gigg
Generate contents page correctly and remove gloassary. Refs #6783
Changeset: 664c93888c5f79a4a6ab22262eaa87e705e099c9
comment:17 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 7629
Add simpleapi to sphinx docs. Refs #6783
Required some minor changes to the way the doc strings were formatted.