Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MkDoxy not invoked in mkdocs-monorepo plugin source tree configuration? #109

Open
moschmdt opened this issue May 30, 2024 · 2 comments
Open
Labels
bug Something isn't working low priority

Comments

@moschmdt
Copy link

moschmdt commented May 30, 2024

I just tested mkdoxy with mkdocs-monorepo plugin with the source-tree configuration. Unfortunately, it seems that the mkdoxy toolchain (?) is not invoked if the mkdoxy is configured in a sub project.

I do not see any INFO - -> Start project belly-rubs in the output log from MkDoxy. Thus, I assume that the project/ plugin is not invoked? I did ensure that MkDoxy works fine on my system.
Might this be a monorepo issue?

Configuring MkDoxy in the root mkdocs.yaml works fine though.

This is the copy of the monorepo source-tree setup and extended:

$ tree .

├── components
│   ├── belly-rubs
│   │   ├── docs
│   │   |   └── index.md
│   │   ├── src
│   │   |   └── main.cpp
│   │   ├── include
│   │   |   └── header.hpp
│   │   └── mkdocs.yml
├── docs
│   └── index.md
└── mkdocs.yml

8 directories, 8 files

I have the configuration of the mkdoxy project configuration in the subproject (source folder), e.g.
components/belly-rubs/mkdocs.yml:

site_name: belly-rubs

theme:
  name: material

nav:
    - index.md
    - Links: belly-rubs/links.md
    - Classes:
          - Class List: belly-rubs/annotated.md
          - Class Index: belly-rubs/classes.md
          - Class Hierarchy: belly-rubs/hierarchy.md
          - Class Members: belly-rubs/class_members.md
          - Class Member Functions: belly-rubs/class_member_functions.md
          - Class Member Variables: belly-rubs/class_member_variables.md
          - Class Member Typedefs: belly-rubs/class_member_typedefs.md
          - Class Member Enumerations: belly-rubs/class_member_enums.m

plugins:
    - search
    - mkdoxy:
          projects:
              belly-rubs:
                  src-dirs: include/ src/
                  full-doc: True
                  doxy-cfg:
                      FILE_PATTERNS: "*.cpp *.hpp"
                      RECURSIVE: True
                      EXTRACT_ALL: True

and the main mkdocs.yaml:

site_name: Cats System

nav:
  - Intro: 'index.md'
  - Components: '*include ./components/*/mkdocs.yml'
  
plugins:
    - search
    - img2figv2
    - monorepo

Used mkdocs versions:

mkdocs==1.6.0
mkdocs-get-deps==0.2.0
mkdocs-img2figv2-plugin==0.0.2
mkdocs-macros-plugin==1.0.5
mkdocs-material==9.5.25
mkdocs-material-extensions==1.3.1
mkdocs-monorepo-plugin==1.1.0
mkdoxy==1.2.4
@JakubAndrysek
Copy link
Owner

Hi, I haven't tested monorepo any time, so I don't know how does it work.

Feel free to test it and fix the behavior trough the PR.

I'm so sorry, but it is not my priority to test them. Maybe in the future.

Have a nice day.
Jacob

@JakubAndrysek JakubAndrysek added bug Something isn't working low priority labels May 30, 2024
@moschmdt
Copy link
Author

moschmdt commented May 31, 2024

Thanks for the clarification! Unfortunately, I do not have time right now to make it a priority or even investigate further.

For now I just use the workaround by specifying mkdoxy in the main mkdocs.yml file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working low priority
Projects
None yet
Development

No branches or pull requests

2 participants