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

Remove OSAL API guide from CFE #1561

Closed
jphickey opened this issue May 20, 2021 · 0 comments · Fixed by #1563 or #1584
Closed

Remove OSAL API guide from CFE #1561

jphickey opened this issue May 20, 2021 · 0 comments · Fixed by #1563 or #1584
Assignees
@jphickey
Labels
build-system docs This change only affects documentation. enhancement
Milestone
Caelum

Comments

@jphickey
Copy link
Contributor

Is your feature request related to a problem? Please describe.
In nasa/osal#1033 the scripts for generating the OSAL API guide are now included in the OSAL repo, based on what CFE had here. With this, it should not be necessary to include the OSAL documentation in the CFE repo any longer.

Describe the solution you'd like
Remove the OSAL API guide config/templates from CFE, and call the OSAL script as a subdirectory to build the OSAL API documentation.

Additional context
Depends on nasa/osal#1033 being merged first (or at the same time)

Requester Info
Joseph Hickey, Vantage Systems, Inc.
@jphickey jphickey self-assigned this May 20, 2021
@jphickey jphickey added docs This change only affects documentation. enhancement labels May 20, 2021
jphickey added a commit to jphickey/cFE that referenced this issue May 20, 2021
@jphickey
Fix nasa#1561, use OSAL script to generate API guide
a98d831 
Instead of including the OSAL API guide templates and pages
in the CFE repo, invoke the build script now provided in
the OSAL repo itself.
@jphickey jphickey mentioned this issue May 20, 2021
Merged
@skliper skliper added this to the 7.0.0 milestone May 20, 2021
jphickey added a commit to jphickey/cFE that referenced this issue May 20, 2021
@jphickey
Fix nasa#1561, also remove dox files now in OSAL
2e0bc9f
astrogeco added a commit that referenced this issue May 27, 2021
@astrogeco
Merge pull request #1563 from jphickey/fix-1561-osal-apiguide
d71583a 
Fix #1561, use OSAL script to generate API guide
@jphickey jphickey mentioned this issue May 28, 2021
Closed
@astrogeco astrogeco mentioned this issue Jun 2, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jphickey jphickey

Labels
build-system docs This change only affects documentation. enhancement
Projects
None yet
Milestone
Caelum
3 participants
@jphickey @skliper @astrogeco