backstage / mkdocs-monorepo-plugin

✚ Build multiple documentation folders in a single Mkdocs. Designed for large codebases.
https://backstage.github.io/mkdocs-monorepo-plugin/
Apache License 2.0
314 stars 75 forks source link

mkdocs_build_plantuml will not work when monorepo enabled #48

Open GAS85 opened 3 years ago

GAS85 commented 3 years ago

Dear all,

I find find out that plugin https://github.com/christo-ph/mkdocs_build_plantuml will not work correctly with monorepo. Problem is that generated SVG/PNG will not be moved to the source folder. Related ticket https://github.com/christo-ph/mkdocs_build_plantuml/issues/9

How to reproduce:

  1. Enable monorepo and plantuml build:
    
    theme:
    name: 'material'

site_dir: source

plugins:

ls -laR source/diagrams ./source/diagrams: total 12 drwxr-xr-x 3 root root 4096 May 17 13:31 . drwxr-xr-x 15 root root 4096 May 17 13:31 .. drwxr-xr-x 2 root root 4096 May 17 13:31 src ./source/diagrams/src: total 12 drwxr-xr-x 2 root root 4096 May 17 13:31 . drwxr-xr-x 3 root root 4096 May 17 13:31 .. -rw-r--r-- 1 root root 474 May 17 13:31 system_quick_overview.puml

NO Folder "out"

Nether folder, or files inside will be moved to source folder. But they exist in docs folder:
```bash
ls -laR /docs/diagrams
./docs/diagrams:
total 16
drwxrwxrwx    4 root     root          4096 May 17 13:30 .
drwxrwxrwx   12 root     root          4096 May 17 13:05 ..
drwxr-xr-x    2 root     root          4096 May 17 13:30 out
drwxrwxrwx    2 root     root          4096 May 17 13:05 src
./docs/diagrams/out:
total 16
drwxr-xr-x    2 root     root          4096 May 17 13:30 .
drwxrwxrwx    4 root     root          4096 May 17 13:30 ..
-rw-r--r--    1 root     root          6884 May 17 13:31 system_quick_overview.svg
./docs/diagrams/src:
total 12
drwxrwxrwx    2 root     root          4096 May 17 13:05 .
drwxrwxrwx    4 root     root          4096 May 17 13:30 ..
-rw-rw-rw-    1 root     root           474 May 17 13:05 system_quick_overview.puml
  1. Disable monorepo and run build. Test that it succeed.
    
    mkdocs build
    INFO    -  Cleaning site directory 
    INFO    -  Building documentation to directory: /source 
    INFO    -  Number headings up to level 3. 
    INFO    -  Generate a table of contents up to heading level 2. 
    INFO    -  Generate a cover page with "default_cover.html.j2". 
    INFO    -  Converting <img> alignment(workaround). 
    INFO    -  Documentation built in 20.54 seconds 
    Converting /docs/diagrams/src/system_quick_overview.puml

ls -la source/diagrams ./source/diagrams: total 16 drwxr-xr-x 4 root root 4096 May 17 13:34 . drwxr-xr-x 15 root root 4096 May 17 13:34 .. drwxr-xr-x 2 root root 4096 May 17 13:34 out drwxr-xr-x 2 root root 4096 May 17 13:34 src ./source/diagrams/out: total 16 drwxr-xr-x 2 root root 4096 May 17 13:34 . drwxr-xr-x 4 root root 4096 May 17 13:34 .. -rw-r--r-- 1 root root 6884 May 17 13:34 system_quick_overview.svg #THIS IS A FILE ./source/diagrams/src: total 12 drwxr-xr-x 2 root root 4096 May 17 13:34 . drwxr-xr-x 4 root root 4096 May 17 13:34 .. -rw-r--r-- 1 root root 474 May 17 13:34 system_quick_overview.puml

camilaibs commented 2 years ago

I can simulate in the first build, in my case the SVG is not added to the source/diagrams/out folder and no errors are printed in the console. But if I build it one more time, it works.