mkdocs must be run from the root folder of the project being documented
Hey,
I've got a non-standard file structure, due to a monorepo containing several projects, one of them being the docs project.
root:
- docs
- mkdocs.yml
- python-sdk
- *.py files
- typescript-sdk
- *.ts files
With the Python handler, I can provide a paths: ["../python-sdk"] option that points to the folder that needs to be scanned for source files.
I would like to have the same option in the TypeScript handler.
Otherwise, I need to bring into the docs project some of the files from the TS project (like package.json, `tsconfig.json), OR run mkdocs from the TS project folder.
mkdocstrings / typescript
A TypeScript handler for mkdocstrings. Available to sponsors only.
2
How does funding with Polar work?
1
Pay now to fund the work behind this issue.
2
Get updates on progress being made.
3
Maintainer is rewarded once the issue is completed.
FAQ
Backer
You're funding impactful open source efforts
Contributor
You want to contribute to this effort
Maintainer
You want to get funding like this too