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

[feature] access docs for devel branch #98

Closed
timotheecour opened this issue Jul 23, 2018 · 4 comments
Closed

[feature] access docs for devel branch #98

timotheecour opened this issue Jul 23, 2018 · 4 comments

Comments

@timotheecour
Copy link
Member

timotheecour commented Jul 23, 2018

something like: https://dlang.org/phobos-prerelease/std_algorithm.html (which even has a way to select the tag/branch eg 2.080 instead of master, although at least allowing to serve docs from tip of devel branch, say updated after every PR would be already a big improvement)

EDIT: this is now implemented as of nim-lang/Nim#8992

@timotheecour
Copy link
Member Author

=> nim-lang/Nim#8423 after this PR, we can work around this by building docs locally (more flexible since allows building docs for arbitrary commits/branches, but maybe still worth publishing docs for devel branch regardless for ease of use for ppl who don't want to build docs locally yet see latest devel docs

@timotheecour
Copy link
Member Author

I believe git hooks could be used for that purpose, ie update docs whenever devel is updated with a new commit, see https://www.digitalocean.com/community/tutorials/how-to-use-git-hooks-to-automate-development-and-deployment-tasks

@awr1
Copy link

awr1 commented Sep 7, 2018

+1 from me. I much prefer to use the online docs more than the locally generated ones, and it would be nice to have the ones from devel up there.

@timotheecour
Copy link
Member Author

thanks @kaushalmodi for implementing this! closing

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