-
Notifications
You must be signed in to change notification settings - Fork 1
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
Refactor auto-generate aeon_acquisition
docs
#49
base: main
Are you sure you want to change the base?
Conversation
2e0696b
to
31a7187
Compare
46924dd
to
c858a2b
Compare
@lochhh one issue with replacing docfx entirely is we will lose the ability to reference these docs from bonsai itself since we need a xrefmap.yml file. Also long term we don't necessarily want to document a bonsai library using pure C# docs since bonsai users don't know much about the C# language and it might be misleading for them. We are making standard doc templates for bonsai in docfx and maintaining two stacks of templates will be really hard for us. Long term I don't really know how best to resolve this yet but I am concerned it will make the docs a bit too different from other packages that people might be lost in how to read them. Let's discuss next week and I can show some of the existing bonsai package doc pages. |
aeon_acquisition
docs are currently generated as.md
files using a combination ofdotnet
anddocfx
.This PR:
aeon_acquisition
docs withaeon_mecha
by replacingdotnet
anddocfx
with Doxygen (to generate XML docs), Breathe and the Sphinx C# domain (to integrate the XML docs with Sphinx)Changes can be previewed here.