Skip to content

mkdocs must be run from the root folder of the project being documented #23

@segfaultxavi

Description

@segfaultxavi

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.

Metadata

Metadata

Assignees

Labels

featureNew feature or request

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions