-
Notifications
You must be signed in to change notification settings - Fork 141
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
Fix SphinxJS/TypeDoc integration #1199
Conversation
These are the last non-native constructors in the code, but TypeDoc doesn't like that. When used with sphinx-js, it cannot find paths for contained methods this way.
Meta party
Something is still wrong with ReadTheDocs' TypeScript/TypeDoc setup: https://readthedocs.org/projects/remotestoragejs/builds/11943970/ It's missing our npm type dependencies apparently, and it looks like it's also using outdated TS. I'm having a look. |
Using latest Python version
I couldn't make it work so far. Looking at a raw build log, it seems to me like RTD is not actually running Improved some other things on the way, like e.g. having more than just master/latest being published. Edit: I found that they actually have a support team and contact, so I wrote them an email about our problem. |
Eric from RTD got back to me and suggested to just hackfix the pre-build step by shelling out from https://remotestoragejs--1199.org.readthedocs.build/en/1199/contributing/docs.html Everything ready to merge now, and it will publish the new docs as "latest", as soon as this PR lands in master. (New default then still being "v1.2.3"/stable.) |
It's almost the same as 'autobuild-docs', but the short version of the ignore arguments (-i) isn't supported anymore by sphinx-autobuild.
Documentation builds are working for me. For the autobuilding I first tried running But that task faild with an error:
Looks like the shorthand version for the But then I noticed that the documentation documentation (doc/contributing/docs.rst) mentions the task In the doc builds themselves I noticed that all number arguments have the type But I guess that can be fixed as part of #1201. |
We'll have to find a solution for that, because the type is actually supposed to be "unknown" in the code, so that TypeScript forces us to validate the unknown input from app authors/code. But yeah, I agree that we can handle that later. |
I couldn't find a solution for the |
Talked about it with @galfert and we came to the conclusion that using normal types instead of |
I just pushed some commits to address the last documentation issue ( /cc @galfert |
Looks good to me 👍 |
The new version of SphinxJS has been released, and it has official TypeDoc support now. I successfully got it running on my machine. But I had to refactor the last remaining non-native classes/functions for the autofunction lookups to work.
closes #1192