Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrated documentation tocs need manual updating when new models are added (Trac #545) #677

Closed
smk78 opened this issue Mar 30, 2019 · 1 comment
Assignees
Labels
Critical High priority Documentation Concerns documentation
Milestone

Comments

@smk78
Copy link
Contributor

smk78 commented Mar 30, 2019

Also see #453

At present the .rst toc files in /sasview/docs/sphinx-docs/source/user/ must be manually updated whenever a new model is added to Sasmodels.

The easiest way to do this is to find the equivalent auto-generated toc in /sasmodels/doc/ref/models and copy the toc entries from the Sasmodels toc to the SasView toc, changing the path ../../model into models/ in the process.

Eventually similar automated processes should be used for both sets of documentation.

For now this ticket is intended as an aide memior.

Migrated from http://trac.sasview.org/ticket/545

{
    "status": "closed",
    "changetime": "2016-03-23T11:29:26",
    "_ts": "2016-03-23 11:29:26.140248+00:00",
    "description": "Also see #318\n\nAt present the .rst toc files in /sasview/docs/sphinx-docs/source/user/ must be manually updated whenever a new model is added to Sasmodels.\n\nThe easiest way to do this is to find the equivalent auto-generated toc in /sasmodels/doc/ref/models and copy the toc entries from the Sasmodels toc to the SasView toc, changing the path ../../model into models/ in the process.\n\nEventually similar automated processes should be used for both sets of documentation.\n\nFor now this ticket is intended as an aide memior.\n",
    "reporter": "smk78",
    "cc": "",
    "resolution": "fixed",
    "workpackage": "SasView Documentation",
    "time": "2016-03-20T15:02:01",
    "component": "SasView",
    "summary": "Integrated documentation tocs need manual updating when new models are added",
    "priority": "critical",
    "keywords": "",
    "milestone": "SasView 4.0.0",
    "owner": "smk78",
    "type": "task"
}
@smk78
Copy link
Contributor Author

smk78 commented Mar 30, 2019

Trac update at 2016/03/23 11:29:26:

  • smk78 commented:

I sorted this before I left Code Camp.

  • smk78 changed resolution from "" to "fixed"
  • smk78 changed status from "new" to "closed"

@smk78 smk78 closed this as completed Mar 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Critical High priority Documentation Concerns documentation
Projects
None yet
Development

No branches or pull requests

1 participant