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

Add typedoc support to build environment #4920

Closed
graup opened this issue Nov 22, 2018 · 5 comments
Closed

Add typedoc support to build environment #4920

graup opened this issue Nov 22, 2018 · 5 comments
Labels
Improvement Minor improvement to code

Comments

@graup
Copy link

graup commented Nov 22, 2018

RTD supports sphinx-js and jsdoc. It works well with build: image: latest.

Recently sphinx-js added typedoc support for typescript. Could typedoc be installed in the builder image? Or is there a way to install it myself?

npm install -g typedoc

Ref #3338

@humitos humitos added the Improvement Minor improvement to code label Nov 22, 2018
@humitos humitos added this to the New build features milestone Nov 22, 2018
@humitos
Copy link
Member

humitos commented Nov 22, 2018

@graup we are already installing jsdoc with npm, so I think it won't be a problem to another npm dependency.

The line that has to be modified is this one:

https://github.com/rtfd/readthedocs-docker-images/blob/master/Dockerfile#L62

Thanks!

@graup
Copy link
Author

graup commented Dec 13, 2018

@humitos can we get this PR merged? thanks

@graup
Copy link
Author

graup commented Jan 15, 2019

As a quick update, I successfully tested the typedoc integration here. It works with sphinx-js as the only requirement, the new latest docker image, and the Python 3 interpreter. I also had to write a setup.py script than does npm install because typedoc needs all the npm packages to properly parse the code.

Thanks!

@humitos
Copy link
Member

humitos commented Jan 15, 2019

@graup thanks a lot for the update on this!

I also had to write a setup.py script than does npm install because typedoc needs all the npm packages to properly parse the code.

Makes sense. I took a look at the dependencies are they does not look to be "general dependencies that we have to include in our image" so I think it's fine to do it in that way (I'd put the os.system call in the docs/conf.py though, since it's only for the documentation and not to install the package --My $0.02)

@humitos
Copy link
Member

humitos commented May 18, 2022

There is a newer a simpler way to specify typedoc now. Check out this comment #3069 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

2 participants