backstage / backstage/mkdocs-monorepo-plugin

Does mkdocs-monorepo-plugin still work with mkdocstrings?

Open
#105 2 comments 0 reactions 0 assignees View on GitHub
question
Dominant language
Python
Stars
400
Forks
80
PR merge metrics
No merged PRs in 30d

Description

I recently had mkdocstring and mkdocs-monorepo-plugin working on a monorepo that was using both sphinx and google style docstrings but now the google style docstring are not rendering properly and only the sphinx docstrings render correctly with the tables.

I can't pinpoint which commit broke this yet.

Has anyone run into any bugs using `mkdocs-monorepo-plugin` and `mkdocstrings`? Specifically, using two types of docstring styles in one codebase (e.g. google style and sphinx).

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the reported behavior with mkdocs-monorepo-plugin and mkdocstrings in a monorepo containing both Google- and Sphinx-style docstrings. Identify the commit or configuration responsible, and consider the issue done when both styles render correctly with their expected tables.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.