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

Added purpose of file #198

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

robertlugg
Copy link

The first words I read were "arm_allinea_studio". This suggested that that is the topic of this document. Instead, add a very brief introduction to describe what this document is for. I've created some text that is OK but feel free to modify.

The first words I read were "arm_allinea_studio".  This suggested that that is the topic of this document.  Instead, add a very brief introduction to describe what this document is for.  I've created some text that is OK but feel free to modify.
@samcmill
Copy link
Collaborator

Great point about missing a description of the document itself. This applies equally to the autogenerated primitives and misc_api documentation as well.

These files are auto generated from the code using pydocmd.

@robertlugg are you up for investigating how a static header can be added to dynamically generated documentation using pydocmd? The configuration file is pydocmd.yml at the top level of the repository.

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.

2 participants