Upgrade @truffle/codec's typedoc to v0.20.36 #4112
Conversation
gnidan
force-pushed
the
codec/upgrade-typedoc
branch
2 times, most recently
from
1b477d8 to
f23ad08
Compare
gnidan
changed the title
gnidan
force-pushed
the
codec/upgrade-typedoc
branch
from
f23ad08 to
c79c807
Compare
- Stop using @gnd/typedoc - Remove typedoc-plugin-external-module-name, since it's now unnecessary (and broken) - Add typedoc-plugin-remove-references to prevent decoder from now displaying ExtrasAllowed, et al. (which exist on codec) - Forward CLI args to `yarn docs` - Move module documentation comments into the modules themselves - Ensure all module documentation comments include @packageDocumentation - Update references inside docs/tsconfig.json's `include` to use proper relative path to that file; apparently it doesn't use rootDir anymore? - Update docs/tsconfig.json to `include` decoder, since somehow it stopped finding those files - Remove now-meaningless options from typedoc config - Fix typedoc config's reference to our typedoc theme, maybe because it's not respecting rootDir?
gnidan
force-pushed
the
codec/upgrade-typedoc
branch
from
c79c807 to
a0df3a5
Compare
There was a problem hiding this comment.
Seems good to me. One additional thing you might want to do -- right now we have a bunch of
import * as Name from "path";
export { Name };We should, if I'm not mistaken, be able to replace this with
export * as Name from "path";I think the reason we didn't do this previously was due to it not playing nicely with typedoc. But with these changes I think it should work now? I could be wrong, it could blow up or something, but if you have the time you might want to try it?
Otherwise this seems good. Thanks for doing this!
| "mode": "modules", | ||
| "module": "commonjs", | ||
| "theme": "../../../node_modules/@trufflesuite/typedoc-default-themes/bin/default/", | ||
| "includeDeclarations": false, |
There was a problem hiding this comment.
Hm, why these deleted lines?
There was a problem hiding this comment.
Those options don't exist anymore!
I'm not sure - I tried this |
|
Thanks Harry! |
This PR removes
@gnd/typedocand replaces it with the latest stable typedoc release.Few things were broken, which this PR accommodates:
@module. Fortunately it seems like this tag works without that, though!@packageDocumentation. This PR hopefully got them all!rootDir; instead, this PR updates those to be relative to thedocs/directory itself.include.