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

Investigate if the doc builder can incorporate some original doc building script features #257

Open
schveiguy opened this issue Sep 18, 2021 · 4 comments

Comments

@schveiguy
Copy link
Collaborator

Original doc builder generated docs including the tagged version, and had some other things. While we probably shouldn't incorporate the historical docs, we can at least possibly make the title nicer.

See build-docs script in the project root for details

@surlymoor
Copy link

For versioning, the workflow could be altered to generate a ddoc file storing a macro that expands to the commit's tag (or commit's hash in the case of no tag). Then just use that macro wherever in the docs. Will have to also dump ddox's output into a folder within gh-pages whose name is $version. This should be possible, but it might take some trial and error.

@schveiguy
Copy link
Collaborator Author

Yep, I think build-docs did something similar.

@surlymoor
Copy link

surlymoor commented Sep 19, 2021

Disregard. This requires somebody who knows what he's doing.

@schveiguy
Copy link
Collaborator Author

Ha, yeah, I know it's possible. I'd like to see it done at some point. I too do not know exactly the right way to do it, but will get around to it at some point.

Thanks for trying!

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

No branches or pull requests

2 participants