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

Improve documentation all over the place #160

Merged
merged 13 commits into from
Apr 8, 2015

Conversation

torbjoernk
Copy link
Contributor

I'm improving the general documentation, slowly but steady. Still way to go.

@torbjoernk
Copy link
Contributor Author

@pint-jenkins retest this please

@torbjoernk
Copy link
Contributor Author

One may call this procrastination ... 😳 😄

@torbjoernk
Copy link
Contributor Author

@memmett Would you mind checking out the revamped docu at https://pint.fz-juelich.de/ci/job/PFASST_PULL_REQUESTS_DOCU/doxygen ?

I'd like to clean up this commit-mess before merging.

- Controllers
- Internals
- Utilities
- Examples
also: fix typo on interface implementation file name.

also: move Polynomial into namespace quadrature
Signed-off-by: Torbjörn Klatt <t.klatt@fz-juelich.de>
newest feature: specify Markdown file as index page
Through this introducing a few colors to the documentation to aid
readability.

Without additional Javascript as TWBS requires jQuery 1.9 and Doxygen
comes with 1.7.
* development:
  poly: Use a fixed number of DKW iterations for roots.
@torbjoernk torbjoernk force-pushed the feature/pimp-my-docu branch from 0dafb5c to f3159ca Compare April 2, 2015 19:30
@torbjoernk torbjoernk changed the title [WIP] Improve documentation all over the place Improve documentation all over the place Apr 2, 2015
@torbjoernk
Copy link
Contributor Author

so I've cleaned up that commit mess to be more descriptive and less confusing

@memmett
Copy link
Member

memmett commented Apr 7, 2015

Killer PR. Only two comments:

  1. At some point we agreed to capitalize the first word in the 'brief' doc string. This PR seems to revert back to lower case.
  2. On the doc server, I see "Changelog" repeated three times in the TOC.

@torbjoernk
Copy link
Contributor Author

Fixed point one. Point two is most likely an artefact of having different versions of the documentation build in the same Jenkins job. When I build it locally in clean build folder it does not occur.

@torbjoernk
Copy link
Contributor Author

@pint-jenkins retest this please

memmett added a commit that referenced this pull request Apr 8, 2015
Improve documentation all over the place
@memmett memmett merged commit 32ba0bf into Parallel-in-Time:development Apr 8, 2015
@torbjoernk torbjoernk deleted the feature/pimp-my-docu branch April 8, 2015 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants