feat: generate API as TypeDoc docs
#1705
Conversation
huwshimi
force-pushed
the
generate-docs
branch
2 times, most recently
from
87b24d6 to
6c5ba16
Compare
|
sounds good! I'll try this later. |
soartec-lab
left a comment
soartec-lab
left a comment
There was a problem hiding this comment.
This is amazing. I have made some comments for improvement, so please check them out 👍
packages/orval/src/write-specs.ts
Outdated
| let out = 'docs'; | ||
| if (app.options.isSet('out')) { | ||
| // Use the output location if it has been set in the external config. | ||
| out = app.options.getValue('out'); | ||
| } else if (output.workspace) { | ||
| // Generate the docs in the workspace. | ||
| out = upath.join(output.workspace, 'docs'); | ||
| } else if (output.target) { | ||
| const base = upath.dirname(output.target); | ||
| // Generate the docs along side the output target. | ||
| out = upath.join(base, 'docs'); | ||
| } |
There was a problem hiding this comment.
I thought that the default specified location should be docs regardless of workspace or target.
These options are not documents, but output destinations for the application's HTTP client, so their nature is different from the document we will be adding this time.
Also, by not supporting those followers, we get the simplicity of the source code.
| let out = 'docs'; | |
| if (app.options.isSet('out')) { | |
| // Use the output location if it has been set in the external config. | |
| out = app.options.getValue('out'); | |
| } else if (output.workspace) { | |
| // Generate the docs in the workspace. | |
| out = upath.join(output.workspace, 'docs'); | |
| } else if (output.target) { | |
| const base = upath.dirname(output.target); | |
| // Generate the docs along side the output target. | |
| out = upath.join(base, 'docs'); | |
| } | |
| const out = app.options.getValue('out') || 'docs'; |
There was a problem hiding this comment.
Thanks. app.options.getValue('out') defaults to docs inside TypeDoc so we can simplify this slightly further and drop the || 'docs'
|
@huwshimi |
…oc config options to be passed
huwshimi
force-pushed
the
generate-docs
branch
from
e00309d to
ff3b8a4
Compare
|
@soartec-lab I rebased and fixed the merge conflict. Tests are passing now. |
soartec-lab
changed the title
TypeDoc docs
3 participants
Status
READY
Description
Generate docs from the output using TypeDoc.
Fixes: #773.
Related PRs
List related PRs against other branches:
Todos
Steps to Test or Reproduce
Outline the steps to test or reproduce the PR here.
orval.config.tsfor an example and adddocs: true,to theoutputobject.yarn generate-api.