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 docs #233

Open
wants to merge 20 commits into
base: ibverb-support
Choose a base branch
from
Open

Update docs #233

wants to merge 20 commits into from

Conversation

dentalfloss1
Copy link
Collaborator

Clarify build instructions in the README file for users who are not using Docker.

Add information on making new packet formats in the C++ development section of the docs.

jaycedowell and others added 20 commits April 22, 2022 14:15
@jaycedowell
Started work on re-enabling support for bifrost.ndarray.astype().
3f06628
@jaycedowell
Start trying out astype().
81e43f9
@jaycedowell
Fixed a few problems and better test coverage.
298b96c
@jaycedowell
Updated for astype().
a57e699
@jaycedowell
Use bifrost.DataType instead of bifrost.dtype.
39526ac
@jaycedowell
Add a catch for IndexError.
0bb8c61
@league
Explicitly include cstdint for gcc13 (#227)
7dc1c5c 
https://gcc.gnu.org/gcc-13/porting_to.html
@jaycedowell
Small update to test #228.
898e4a8
@jaycedowell
Another small update to test #228.
de72fab
@jaycedowell
Update which version of ctypesgen to use.
56b84d2
@jaycedowell
Merge branch 'master' into astype-support
92240df
@jaycedowell
Bad merge.
b706d5e
@jaycedowell
Better comments plus formatting fixes.
02434e2
@jaycedowell
Indentation.
0477754
@dentalfloss1
Merge pull request #177 from ledatelescope/astype-support
b91235b 
Support for `astype()` on `bifrost.ndarray`'s
clarify the README for the docs
3c6c912
include docs on writing packet formats
774cb48
@jaycedowell
Cleanup whitespace
7e97eba
@jaycedowell
Formatting.
6445e69
@jaycedowell
Also need breathe.
3a2c4aa
@jaycedowell jaycedowell changed the base branch from master to ibverb-support May 3, 2024 16:02
@jaycedowell
Copy link
Collaborator

Some other things to think about:

  • Should the Makefile in docs also run doxygen as part of building the docs?
  • Should there be some toggle in configure/a Makefile that makes things work even without doxygen?
  • Should we also test for sphinx/breathe or something like extras_require in the setup.py?
  • Should the top-level Makefile have a make docs option that builds everything if Python/doxygen are installed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@dentalfloss1 @jaycedowell @league