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

Refactoring documentation #989

Merged
merged 5 commits into from
Jun 27, 2023

Conversation

SeverinDiederichs
Copy link
Member

This is the first PR in a series of PRs to improve the readthedocs documentation.

  1. It updates the GH readme. Here, also the HiPACE++ workshop is announced.
  2. The HiPACE++ workshop is announced on the RTD doc as well.
  3. The general index is improved
  4. The parameter section is better ordered, although more ordering is needed.
  • Small enough (< few 100s of lines), otherwise it should probably be split into smaller PRs
  • Tested (describe the tests in the PR description)
  • Runs on GPU (basic: the code compiles and run well with the new module)
  • Contains an automated test (checksum and/or comparison with theory)
  • Documented: all elements (classes and their members, functions, namespaces, etc.) are documented
  • Constified (All that can be const is const)
  • Code is clean (no unwanted comments, )
  • Style and code conventions are respected at the bottom of https://github.com/Hi-PACE/hipace
  • Proper label and GitHub project, if applicable

@SeverinDiederichs SeverinDiederichs added the documentation Improvements or additions to documentation label Jun 26, 2023
Copy link
Member

@MaxThevenet MaxThevenet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks for this PR! few comments/typos below, I'll just commit and merge.

README.md Outdated Show resolved Hide resolved
docs/source/building/hpc.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/run/parameters.rst Outdated Show resolved Hide resolved
docs/source/run/parameters.rst Outdated Show resolved Hide resolved
docs/source/run/parameters.rst Outdated Show resolved Hide resolved
docs/source/run/parameters.rst Outdated Show resolved Hide resolved
docs/source/run/parameters.rst Outdated Show resolved Hide resolved
docs/source/run/parameters.rst Outdated Show resolved Hide resolved
@MaxThevenet MaxThevenet merged commit ed383dc into Hi-PACE:development Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants