Ticket #9678 (closed: fixed)
Algorithm and fit function index pages need to be moved
| Reported by: | Peter Peterson | Owned by: | Martyn Gigg |
|---|---|---|---|
| Priority: | blocker | Milestone: | Release 3.2 |
| Component: | Documentation | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Peter Peterson |
Description
They should be in:
- algorithms/index.html
- algorithms/categories/index.html
- fitfunctions/index.html
This also requires moving the categories and renaming fitfunctions.
Change History
comment:4 Changed 6 years ago by Martyn Gigg
Put categories pages in a subdirectory of each doc type.
Refs #9678
Changeset: 617f3010da5ba2b48ce131ee87cf378e4ee8fbbb
comment:6 Changed 6 years ago by Martyn Gigg
Move functions to FitFunctions category.
Refs #9678
Changeset: 56ad1dcdb2a5e04969d2184bedd8c41672c22a4a
comment:7 Changed 6 years ago by Martyn Gigg
Write out index.html pages for a pre-defined set of categories.
Refs #9678
Changeset: 497ca3371ac504df46d716f45b2e88efdede4fd0
comment:8 Changed 6 years ago by Martyn Gigg
Update main index page and add api index page.
Refs #9678
Changeset: cf4a25924c88d7afa03f94c9bc6557ece6b41afb
comment:9 Changed 6 years ago by Martyn Gigg
Remove custom styling for description list tags.
The standard spacing seems just fine. Refs #9678
Changeset: ff843ac1405c479a2db59fa6166a7a23f2aad4ea
comment:10 Changed 6 years ago by Martyn Gigg
- Status changed from inprogress to verify
- Resolution set to fixed
Branch: feature/9678_docs_index_pages
Tester: Merge the branch and build the html target. Check the category links for some algorithms and fit functions. They should now reference pages in categories subdirectories of the appropriate directory. There should also now be an index.html file in each subdirectory of the documentation tree. The index file in algorithms/index.html should show the Algorithms category page and the index file in fitfunctions/index.html should show the FitFunctions category page
comment:11 Changed 6 years ago by Peter Peterson
- Status changed from verify to verifying
- Tester set to Peter Peterson
comment:12 Changed 6 years ago by Peter Peterson
Currently this is generating an error (on f20):
Exception occurred:
File "/home/pf9/code/mantid/Code/Mantid/docs/sphinxext/mantiddoc/directives/categories.py", line 240, in _create_links_and_track
link_rst += "`%s <%s>`_ | " % (categ_name, category.link(docdir))
TypeError: 'str' object is not callable
comment:13 Changed 6 years ago by Martyn Gigg
Force everything to be rebuilt on incremental builds
The Category objects in the categories directive have been pickled so changing the structure can lead to problems for incremental builds. Refs #9678
Changeset: 430da21dd2a42c1206834d9e54f987e81f9ba7f4
comment:14 Changed 6 years ago by Pete Peterson
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9678_docs_index_pages'
Full changeset: 28345edfe79481bbca61a2099db30540ed31a722
comment:15 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10520
