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

Add setup for user and developer documentation #74

Merged
merged 31 commits into from
Aug 26, 2024
Merged
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
7d19af1
Add outline for adding user and developer documentation
oruebel Aug 8, 2024
bc4b68c
Merge branch 'main' into start_user_docs
oruebel Aug 8, 2024
6aff062
Add flush function for the IO and fix test build warnings for testHDF5IO
oruebel Aug 9, 2024
58b515c
Add HDF5 example code snippet that is run in the tests
oruebel Aug 9, 2024
cbc0631
Fix lint issues
oruebel Aug 9, 2024
b175b17
Fix codespell
oruebel Aug 9, 2024
ba9fcc4
Fix lint
oruebel Aug 9, 2024
f8577d3
Move examples to tests/examples subfolder
oruebel Aug 15, 2024
a0d4f62
Update line breaks in LICENSE
oruebel Aug 15, 2024
443620a
Add legal abd build instructions to the docs
oruebel Aug 15, 2024
07d0e69
Attempt to fix test failure
oruebel Aug 21, 2024
c97caa7
Add codespell to the requirements
oruebel Aug 21, 2024
d904ca1
Add Doxygen commands to the codespell ignore list
oruebel Aug 21, 2024
a869fdb
Add brief testing docs
oruebel Aug 21, 2024
a4ed61c
Add HDF5 I/O SWMR and Chunking docs
oruebel Aug 21, 2024
5ffdea6
Add docstrings for namespaces
oruebel Aug 21, 2024
19b2660
Move install docs and diverse fixes
oruebel Aug 21, 2024
711b6e1
Add example with SMWR disabled
oruebel Aug 21, 2024
44dc911
Add dot figures for the HDF5IO docs
oruebel Aug 22, 2024
66cb457
Fix section levels
oruebel Aug 22, 2024
fbac49d
Add format-fix and spell-fix targets in the docs
oruebel Aug 22, 2024
da190c2
Apply suggestions from code review
oruebel Aug 24, 2024
c05a2e3
Separate User and Developer installation docs
oruebel Aug 25, 2024
686a1a3
Apply suggestions from code review
oruebel Aug 25, 2024
e8cf56d
Update docs/pages/2_devdocs.dox
oruebel Aug 25, 2024
ae3dd83
Add links to the installation docs on the README.md page
oruebel Aug 25, 2024
5736bc3
Merge branch 'start_user_docs' of https://github.com/lbl-cbg/aq-nwb i…
oruebel Aug 25, 2024
d660b60
Add documentation on how to write Documentation in Doxygen
oruebel Aug 25, 2024
046c292
Fix format check errors
oruebel Aug 25, 2024
760772f
Update tests/CMakeLists.txt
oruebel Aug 26, 2024
62fc6f7
Apply suggestions from code review
oruebel Aug 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Merge branch 'main' into start_user_docs
  • Loading branch information
oruebel authored Aug 8, 2024
commit bc4b68c3b3fcf78adb3bc116e5652462eeb3f0f1

This merge commit was added into this branch cleanly.

There are no new changes to show, but you can still view the diff.