Skip to content

Use doc builder v4#87

Merged
shuchitak merged 16 commits intoxmos:developfrom
BrennanGit:feature/doc_builder_v4
Sep 29, 2023
Merged

Use doc builder v4#87
shuchitak merged 16 commits intoxmos:developfrom
BrennanGit:feature/doc_builder_v4

Conversation

@BrennanGit
Copy link
Copy Markdown
Contributor

@BrennanGit BrennanGit commented Sep 20, 2023

This includes a few changes to support the new doc_builder:

  • doxygen multiple includes replaced by single inclusion of doxygengroup and :c:func: to create references
  • change top-level of programming guide from includes to a toc
    • required change in doc builder to remove README from default exclusions list
  • change name of settings file in lib checks (conveniently, version remains on line 4, but it's not guaranteed)
  • Jenkinsfile update to make parallel docs build

https://xmosjira.atlassian.net/browse/AP-150

@mbanth mbanth assigned BrennanGit and unassigned mbanth Sep 28, 2023
Copy link
Copy Markdown
Contributor

@shuchitak shuchitak left a comment

Choose a reason for hiding this comment

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

Looks great!

@shuchitak shuchitak merged commit 4c2560d into xmos:develop Sep 29, 2023
@BrennanGit
Copy link
Copy Markdown
Contributor Author

Bare in mind, v4 hasn't been released yet so we'll need to update the image tag once it's done.
Also as per discussion in lib_xcore_math, I'm not sure it's worth zipping up the docs as we lose the ability to render them.

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.

3 participants