Ticket #9624 (closed: fixed)
Incorporate python sphinx docs into new documentation structure
| Reported by: | Martyn Gigg | Owned by: | Martyn Gigg |
|---|---|---|---|
| Priority: | blocker | Milestone: | Release 3.2 |
| Component: | Documentation | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Peter Peterson |
Description
Change History
comment:2 Changed 6 years ago by Martyn Gigg
- Status changed from assigned to inprogress
Allow sphinx to be run without MantidPlot.
The documentation for the mantidplot & the screenshots will be missing but it can be useful to be able to do this to aid debugging. Refs #9624
Changeset: 3337a2c1a807dfcfc7e09d115666319349e67722
comment:3 Changed 6 years ago by Martyn Gigg
Snapshot what is generated by the old sphinx autogen_api mechanism.
The files will now live as first-class citizens allowing more controlled customization of some files. Refs #9624
Changeset: e122a2bbb8de85b4f24bf7ec61c60edc8e24836a
comment:4 Changed 6 years ago by Martyn Gigg
Minor alteration to main index file
Use the standard for H1 titles. Refs #9624
Changeset: f5564d9de7ecd9d4f5fce64b000e890f36aa1557
comment:5 Changed 6 years ago by Martyn Gigg
Add in the old attempts to for hooking up breath & doxygen...
to Sphinx. We don't want to lose the information. Refs #9624
Changeset: ea99dc5687dbd95857ae4558f875bc36442af1d5
comment:6 Changed 6 years ago by Martyn Gigg
Add skipping mechanism autodoc
It currently just skips init like the old one did Refs #9624
Changeset: f080956d4d684a33631b5029ba1b6a2f0b609f3f
comment:7 Changed 6 years ago by Martyn Gigg
Fill in the version string in the Sphinx config
Refs #9624
Changeset: c92765afdb447c44488d75508ce6c8be845d425d
comment:8 Changed 6 years ago by Martyn Gigg
Fix warning about missing blank line.
Refs #9624
Changeset: c4c6a0fc6aba2cc965d36fdba99be357192ede6d
comment:9 Changed 6 years ago by Martyn Gigg
Clear warning about error in toctree directive.
Refs #9624
Changeset: db561c56591708ae8044021d48f9de95b2d9ca5c
comment:10 Changed 6 years ago by Martyn Gigg
Add calibration pages from the old sphinx docs.
Refs #9624
Changeset: 9ab5d34554f94e85fb43d53d87c1e81be0a548fa
comment:11 Changed 6 years ago by Martyn Gigg
Include api/python in the main toctree
Refs #9624
Changeset: 31853c86fd92da5be89984ed244a4a6cd5797ee6
comment:12 Changed 6 years ago by Martyn Gigg
Add the changes.rst document from the old sphinx docs.
Refs #9624
Changeset: f8e7be18642d8e17330c78cb0905057618939408
comment:13 Changed 6 years ago by Martyn Gigg
comment:14 Changed 6 years ago by Martyn Gigg
Rename a file to avoid a name clash on case-insensitive filesystems.
Refs #9624
Changeset: 87e95e885393244a4afc3370a79ca00d5ea195c6
comment:15 Changed 6 years ago by Martyn Gigg
Swap doctest blocks for standard code blocks in calibration
Refs #9624
Changeset: 20533529741a5136478d3557e038c02642735785
comment:16 Changed 6 years ago by Martyn Gigg
- Status changed from inprogress to verify
- Resolution set to fixed
comment:17 Changed 6 years ago by Peter Peterson
- Status changed from verify to verifying
- Tester set to Peter Peterson
comment:18 Changed 6 years ago by Pete Peterson
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9624_python_docs_to_static_rst'
Full changeset: 94bdef9c833be794a42d9a229b2e15f280af32d9
comment:19 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10467
