Ticket #9562 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Migrate wiki text from cpp files to separate reST files

Reported by: Martyn Gigg Owned by: Martyn Gigg
Priority: blocker Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester:

Description


Change History

comment:1 Changed 6 years ago by Martyn Gigg

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Martyn Gigg

  • Status changed from assigned to inprogress

Skip properties directive if there are no properties

Refs #9562

Changeset: 28995a15eea34edafcb15c996fd27072c7822189

comment:3 Changed 6 years ago by Martyn Gigg

Add an empty index file as Sphinx needs one to run successfully.

Refs #9562

Changeset: 04bc795be6436089be5c9a521788289bb99a1288

comment:4 Changed 6 years ago by Martyn Gigg

Fix deprecated algorithm reference link.

Refs #9562

Changeset: d482ab19967ae093feef4a5f1b7aec4e24d37cc3

comment:5 Changed 6 years ago by Martyn Gigg

Disable QtAssistant for documentation transition

Refs #9562

Changeset: 2d45e5df66ed796fd3ea3f5a9e27b2fba11d85e5

comment:6 Changed 6 years ago by Martyn Gigg

Update README regarding images.

Refs #9562

Changeset: 3c3a13e64d4a14619b7c37f99bf0af0467ff88e1

comment:7 Changed 6 years ago by Martyn Gigg

Use ImageNotFound.png when no image available.

Refs #9562

Changeset: b6b04dc26a56e6179134679dff555d34c641693d

comment:8 Changed 6 years ago by Martyn Gigg

Fix categories output to allow a namespace.

Refs #9562

Changeset: a173e6632027dca16a540663dbf46aa65326689d

comment:9 Changed 6 years ago by Martyn Gigg

Pull out wiki sections from cpp files and convert them to reST

The converted text is stored in separate .rst files in the docs directory. Refs #9562

Changeset: f0e39c9ad836a3a63cccc55ff1d08c88a12bcf86

comment:10 Changed 6 years ago by Martyn Gigg

Move images from qtassistant directory to Sphinx source directory.

Refs #9562

Changeset: b9fe7a427900ce7702908e6c4c514b8eb7528ac7

comment:11 Changed 6 years ago by Martyn Gigg

Rename aliases directive to alias

Refs #9562

Changeset: 53d50fb66103e2ca1fe801c700d64d88d4146c55

comment:12 Changed 6 years ago by Martyn Gigg

Fix image links in some rst files

Refs #9562

Changeset: 00e2d3746d867bd4a5f4a46f7aeec083d59360b0

comment:13 Changed 6 years ago by Martyn Gigg

Standardize heading characters

Uses # to denote a html h3 heading. Refs #9562

Changeset: 99ea59ff98793c1963e478e5743920720eede761

comment:14 Changed 6 years ago by Martyn Gigg

Disable screenshot generating in doc-test mode.

They are not necessary and they slow down the build quite considerably. Refs #9562

Changeset: 02a5c1fc2f2aba49d689b140cead8efefc2fd1bf

comment:15 Changed 6 years ago by Martyn Gigg

Add global doctest setup code.

Runs the given code before each test is executed. Refs #9562

Changeset: 0c49e013334b8802ce65d2741598cade26aeb8d4

comment:16 Changed 6 years ago by Martyn Gigg

Add usage examples to Rebin.

Refs #9562

Changeset: 663345b49199fcfb74c272d09b85f5a56d4320ad

comment:17 Changed 6 years ago by Martyn Gigg

Wire up alias directive correctly.

Refs #9562

Changeset: 4296b70623e95451d552bc39a07cec13cdd08eb9

comment:18 Changed 6 years ago by Martyn Gigg

Fix ..code directives to correct ..code-block

Refs #9562

Changeset: 7a8ffdaa122954a50f3681598ebc63105765e396

comment:19 Changed 6 years ago by Martyn Gigg

Fix generation of redirects.

It no longer tracks algorithms as each build doesn't necessarily go through every file. It just uses the factory to construct redirects for everything. Refs #9562

Changeset: 1e696d5161d265a655269250c07e5cda879357ba

comment:20 Changed 6 years ago by Martyn Gigg

Fix algorithm page references

The page reference must be before the page title so that it can be referenced without including the link text. Refs #9562

Changeset: a8ab59f00cc04685054070cf6e285c53dbca2dba

comment:21 Changed 6 years ago by Martyn Gigg

Fix internal algorithm links.

The first underscore is not included in the reference name. Refs #9562

Changeset: e36bbb8e157e6eeed2503dd8afefc46898aa631a

comment:22 Changed 6 years ago by Martyn Gigg

Add usage examples to a few doc files.

Some data has been shuffled as a result. Refs #9562

Changeset: 6e51c8a30af7399c7978bffd8cd6068c0e6bc048

comment:23 Changed 6 years ago by Martyn Gigg

Add dependencies Framework as dependency on documentation.

Refs #9562

Changeset: f12123ef7a31a5124c09a4374cab122b0a9c2184

comment:24 Changed 6 years ago by Martyn Gigg

PlotAsymmetryByLogValue will need Muon files in same directory.

Also removes some of the MUSR files that are not actually used in the tests anywhere. Refs #9562

Changeset: b728fafdbc08ec5f55fc8d788e1338379b8f3a03

comment:25 Changed 6 years ago by Martyn Gigg

  • Status changed from inprogress to verify
  • Resolution set to fixed

Branch: feature/9562_wiki_docs_to_rst

Tester: The code should build and the tests should pass. The minor code changes were necessary to get the tests passing after some files in AutoTestData were moved around.

If you have Sphinx and the theme installed then the docs-html target should exist and build, it will produce a lot of warnings though.

comment:26 Changed 6 years ago by Martyn Gigg

Use one less MUSR file in Python test.

Refs #9562

Changeset: 4df09e49a5b3209ea6ecb154321142b276543671

comment:27 Changed 6 years ago by Russell Taylor

  • Status changed from verify to closed

Merge remote branch 'origin/feature/9562_wiki_docs_to_rst'

Full changeset: e2afd784aab25ea75e3b7fb086b74e225a970127

comment:28 Changed 6 years ago by Russell Taylor

I've passed this (admittedly without checking all of the moved wiki sections) as the task described in the ticket title has been done.

I say 'done', but a search for "WIKI" turns up a few occurrences of it in unusual places - see #9592 for that.

Also, "make docs-html" does not work on my RHEL6 box. It gives the error:

Exception occurred:
   File "/home/tr9/TestingMantid/Code/Mantid/docs/sphinxext/mantiddoc/directives/properties.py", line 74, in _build_table
   formatter.format(*item) for item in table_content]
ValueError: zero length field name in format

comment:29 Changed 6 years ago by Martyn Gigg

Turns out that was a Python 2.6 problem. I've fixed it in #9593.

comment:30 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10405

Note: See TracTickets for help on using tickets.