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

SDFormat Specification website should be updated automatically #1291

Open
azeey opened this issue Jun 12, 2023 · 5 comments
Open

SDFormat Specification website should be updated automatically #1291

azeey opened this issue Jun 12, 2023 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@azeey
Copy link
Collaborator

azeey commented Jun 12, 2023

Desired behavior

The specifications on http://sdformat.org/spec should be updated automatically when changes are made to the spec files in the source.

Alternatives considered

Implementation suggestion

Additional context

@azeey azeey added the enhancement New feature or request label Jun 12, 2023
@azeey azeey self-assigned this Jun 12, 2023
@jwnimmer-tri
Copy link
Contributor

In the meantime, could you point to the code that generates those pages? I assume there is code somewhere that converts these files into the HTML documentation, but I haven't been able to find it yet after a few minutes of searching. I'd like to try running it locally on the latest spec (spec 1.11 isn't on the website yet).

@azeey
Copy link
Collaborator Author

azeey commented Dec 12, 2023

Unfortunately, the code that does that is currently in a private repo. But I'll go ahead and update the website.

@azeey
Copy link
Collaborator Author

azeey commented Dec 13, 2023

I've updated the website.

@jwnimmer-tri
Copy link
Contributor

Bigger picture -- Drake implements a subset of the full specification. We have a goal of publishing the "Drake fork" of that documentation (on the Drake website), based on our subset. If the docs-generating code is provided soon as open-source, then we'd probably choose to run the same tooling. If not, then we'll implement a new html-docs-from-schema tool ourselves, local to Drake.

@azeey
Copy link
Collaborator Author

azeey commented Dec 13, 2023

The plan is to convert the website to use a static site generator. At that point, the spec->html generation code will also be open-source. As @EricCousineau-TRI probably recalls, this was on our todo list, but we didn't have time to get to it. I hope we'll have it done this year, but I don't have a more solid timeline.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: To do
Development

No branches or pull requests

2 participants