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.

Sign up for GitHub

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

Jump to bottom

Update rst documentation #36

Open
4 of 6 tasks
thclark opened this issue Jan 18, 2019 · 0 comments
Open
4 of 6 tasks

Update rst documentation #36

thclark opened this issue Jan 18, 2019 · 0 comments
Assignees
@thclark
Labels
documentation Improvements or additions to documentation

Comments

@thclark
Copy link
Contributor

thclark commented Jan 18, 2019 •
edited
Loading

  • Rewrite the main documentation to remove irrelevant sections and descriptions
  • Systematically update references throughout documentation from the copied reference notes to properly cross link against the bibliography
  • Update all references to OAS and OceanArraySystems throughout
  • Go through and check equations on all functions (solving issue Display rendered latex in autodoc #35 might help)
  • Add octue favicon and logo
  • Add examples
thclark pushed a commit that referenced this issue Jan 18, 2019
DOC Added and clarified class members as WIP for #36 - note that inli…
704aba0 
…ne LaTeX works successfully, providing a possible workaround for #35
thclark pushed a commit that referenced this issue Feb 6, 2019
DOC Major refactor and improvement of documentation against #36
28abad5
thclark pushed a commit that referenced this issue Feb 22, 2019
Updated documentation with examples in C++ and python, against #36
be796ff
@thclark thclark self-assigned this Feb 27, 2019
@thclark thclark added the documentation Improvements or additions to documentation label Sep 4, 2019
@thclark thclark removed this from Octue Board Dec 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thclark thclark

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@thclark