Ticket #4411 (closed: fixed)
Add CMake target for Python Sphinx documentation
| Reported by: | Martyn Gigg | Owned by: | Martyn Gigg |
|---|---|---|---|
| Priority: | major | Milestone: | Release 2.1 |
| Component: | Mantid | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Stuart Campbell |
Description
Change History
comment:2 Changed 9 years ago by Nick Draper
- Milestone changed from Iteration 32 to Iteration 33
Moved to iteration 33 at iteration 32 code freeze
comment:3 Changed 9 years ago by Martyn Gigg
Refs #4411. Minor mod to sphinx conf to include version numbers.
Changeset: b2bff39c18795644d5f23debf3dff7a70ad202fd
comment:4 Changed 9 years ago by Martyn Gigg
Refs #4411. A better name for the api doc directory
Changeset: 6e19a13cd3d79539deb5a7dad680310ee2e9dad1
comment:5 Changed 9 years ago by Martyn Gigg
Refs #4411. A first-cut at autogenerating Python API doc.
Changeset: a30035bac4de770fd6aa8ca9a9d88d3d07577507
comment:6 Changed 9 years ago by Martyn Gigg
Refs #4411. Move Python docs to MantidPlot directory
Include mantidplotpy in the docs as well.
Changeset: c1b753f9c09e989a42a6b1f6f025d977e6c68577
comment:7 Changed 9 years ago by Martyn Gigg
Refs #4411. Remove doc reference.
Changeset: 213514407baedcd301f6e771bda10fdb91be1bec
comment:8 Changed 9 years ago by Martyn Gigg
Refs #4411. Minor mod to sphinx conf to include version numbers.
Changeset: b2bff39c18795644d5f23debf3dff7a70ad202fd
comment:9 Changed 9 years ago by Martyn Gigg
Refs #4411. A better name for the api doc directory
Changeset: 6e19a13cd3d79539deb5a7dad680310ee2e9dad1
comment:10 Changed 9 years ago by Martyn Gigg
Refs #4411. A first-cut at autogenerating Python API doc.
Changeset: a30035bac4de770fd6aa8ca9a9d88d3d07577507
comment:11 Changed 9 years ago by Martyn Gigg
Refs #4411. Move Python docs to MantidPlot directory
Include mantidplotpy in the docs as well.
Changeset: c1b753f9c09e989a42a6b1f6f025d977e6c68577
comment:12 Changed 9 years ago by Martyn Gigg
Refs #4411. Remove doc reference.
Changeset: 213514407baedcd301f6e771bda10fdb91be1bec
comment:13 Changed 9 years ago by Martyn Gigg
Refs #4411. Something now resembling documentation.
The API bits need a some tidy up but they are at least there and can be searched.
Changeset: 23b6d7f1cc146e6b0da0805c38442ef099fa71a3
comment:14 Changed 9 years ago by Martyn Gigg
Refs #4411. Restore stdout redirection for IPython.
Changeset: 19a7082687d43af27ddd7d0cad1054786a780162
comment:15 Changed 9 years ago by Martyn Gigg
Refs #4411. Add a latex (for a pdf) target to sphinx.
The output PDF is not ideal at the moment but it is a start.
Changeset: 2feb4bd500a937ed3d9a1bb6d5878539c5411ea3
comment:16 Changed 9 years ago by Martyn Gigg
Refs #4411. Add a latex (for a pdf) target to sphinx.
The output PDF is not ideal at the moment but it is a start.
Changeset: 2feb4bd500a937ed3d9a1bb6d5878539c5411ea3
comment:17 Changed 9 years ago by Martyn Gigg
Refs #4411. Add a changes document to the sphinx doc.
Changeset: 87801b9c788aacde22c03a681eb4692a65e30696
comment:18 Changed 9 years ago by Martyn Gigg
Refs #4411. Update getting started link.
Changeset: 6baada348ccd5e4e6a9850bdd253d7c0858db99e
comment:19 Changed 9 years ago by Martyn Gigg
Refs #4411. Update getting started link.
Changeset: 6baada348ccd5e4e6a9850bdd253d7c0858db99e
comment:20 Changed 9 years ago by Martyn Gigg
Refs #4411. Change sphinx style and resize icon.
Changeset: 9c0bd387479bd865f4cfb13c6b8c06436148ac26
comment:21 Changed 9 years ago by Martyn Gigg
Refs #4411. Change sphinx style and resize icon.
Changeset: 9c0bd387479bd865f4cfb13c6b8c06436148ac26
comment:22 Changed 9 years ago by Martyn Gigg
Refs #4411. Add something about qti->mantidplot
Changeset: 65f1bd7a2146eb4539cbe122c9ecefb3b2d6b6bb
comment:23 Changed 9 years ago by Martyn Gigg
Refs #4411. Update changes section with getSampleDetails removal.
Changeset: 85d0d6a4b440ae0155ed4fc40f825b6b23196bd0
comment:24 Changed 9 years ago by Martyn Gigg
Refs #4411. Add doc change about mtd.settings -> config.
Changeset: cfdc8d9b852426fbc777d65156ddd35f5a3707f8
comment:26 Changed 9 years ago by Martyn Gigg
If you have sphinx installed then type "make sphinx-html" and that will generate the docs. The easiest way to get sphinx is to do "easy_install sphinx"
comment:27 Changed 9 years ago by Martyn Gigg
- Status changed from accepted to verify
- Resolution set to fixed
comment:28 Changed 8 years ago by Stuart Campbell
- Status changed from verify to verifying
- Tester set to Stuart Campbell
comment:29 Changed 8 years ago by Stuart Campbell
- Status changed from verifying to closed
I seem to get documentation if I type make sphinx-html.
comment:30 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 5258
Refs #4411. Add a cmake target for generating the Python doc.
Need to add some mechanism to generate the rst files when a class is exported.