Skip to content
This repository has been archived by the owner on Jun 17, 2021. It is now read-only.

Fix typedoc URL generation (for /docs) #181

Merged
merged 2 commits into from
Feb 20, 2019
Merged

Fix typedoc URL generation (for /docs) #181

merged 2 commits into from
Feb 20, 2019

Conversation

robiiinos
Copy link
Contributor

@robiiinos robiiinos commented Feb 20, 2019

This PR replace #180

According to the https://github.com/TypeStrong/typedoc#theming documentation, we're able to specify the branch to stick with when generating docs. According to the current README.md, I specified the master branch.

I also re-build the docs to fix all of this.
Thanks @s1na for helping me out !

PS : We should be able to keep the docs generated as it is until you change the *.ts file

@s1na
Copy link
Contributor

s1na commented Feb 20, 2019

That was fast!

Ah, this PR seems to also fix an issue with union types, I imagine because you have a newer version of typedoc installed and they've fixed this.

This already looks good to me. I think having the docs point to master instead of a specifi commit is more flexible and less likely to break. And in the worst case, if the docs are out-dated, they would point to a wrong line. I think it's a good trade-off. @holgerd77 what do you think?

Copy link
Member

@holgerd77 holgerd77 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@s1na Yes, I think so too, thanks @robiiinos for the PR! 😄

Side note: I think doc generation process has settled enough, we should also take on ethereumjs/ethereumjs-config#11 short-term. This PR is again a perfect example why this matters (even if we just have ONE single build command in it). Such a change would otherwise have to be re-distributed throughout all the libraries.

@holgerd77 holgerd77 merged commit ca4eef1 into ethereumjs:master Feb 20, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants