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

Update docs #233

Merged
merged 34 commits into from
Jul 16, 2024
Merged

Update docs #233

merged 34 commits into from
Jul 16, 2024

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 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?

@jaycedowell
Copy link
Collaborator

I've made some changes to configure. It now:

  • emits a warning if doxygen isn't found about how the docs cannot be built
  • tests for the sphinx-build, sphinx-apidoc, and breathe-apidoc scripts
  • emits a warning if sphinx-* or breathe-apidoc are not found about how the Python docs cannot be built
  • updates make doc to build all possible docs with the Python stuff built as "singlehtml"
  • updates docs/Makefile to a .in file so that it is consistent with all other build files and uses the configure-detected values for the paths.

I think that covers it. We should also update master once we're happy with these doc build changes.

clarify ctags install
Further clarification on ctags install
Clarifications to docs instructions
@dentalfloss1
Copy link
Collaborator Author

I made quite a few changes to the README. Let me know what you think
\

@jaycedowell jaycedowell merged commit ccb5eb7 into ibverb-support Jul 16, 2024
13 of 14 checks passed
@jaycedowell jaycedowell deleted the update-docs branch July 16, 2024 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants