Skip to content

site_dir contains folders (and subfolders) from doc_dir though not specified in mkdocs.yml #1152

@Tset-Noitamotua

Description

@Tset-Noitamotua

After doing mkdocs build I expected to find in the site_dir only the rendered .html files in according folder structure as defined by pages: in mkdocs.yml + some mkdocs specific assets. Instead I find there every file and folder/subfolder from docs_dir.

Am I doing something wrong?

I am building test documentation for several projects which are all in my local workspace. So I'm kind of using mkdocs not as supposed to be used to build doculmentation per single project but instead for test docu only but for multiple projects at once. But the only relevant raw .md files are in project_folder/src/test/robotframework/TESTS (subsubsubfolder of each project)
e.g. ugly_app/src/test/robotframework/TESTS/test_doc.md.

My docs_dir tree looks akin like:

│   ├───ugly_app
│   │   └───src
│   │       ├───main
│   │       │   ├───java
│   │       │   │   └───com
│   │       │   │       └───mycompany
│   │       │   │           ├───...
│   │       │   │           │   └───...
│   │       │   │           │       └───...
│   │       │   │           └───....
│   │       │   │               └───...
│   │       │   │                   ├───...
│   │       │   │                   ├───...
│   │       │   │                   │   ├───...
│   │       │   │                   │   │  
│   │       │   │                   │   └───..
│   │       │   │                   ├───...
│   │       │   │                   ├───...
│   │       │   │                   │   └───...
│   │       │   │                   │       └───...
│   │       │   ├───...             ...
│   │       │   │   ├───...
│   │       │   │   │   └───..
│   │       │   │   │       └───...
│   │       │   │   ├───...
│   │       │   │   ├───...
│   │       │   │   └───.
│   │       │   └───...
│   │       │       ├───..
│   │       │       └───.
│   │       └───test
│   │           ├───java
│   │           │   └───com
│   │           │       └───mycompany
│   │           │           └───...
│   │           │               └──...
│   │           │                   ├───...
|   |           |                   ...
│   │           └───robotframework
│   │               ├───...
│   │               ├───...
│   │               │   └───...
│   │               ├───TESTS
│   │               ...
│   │               
│   ├───SCArchive_20111111Test
│   │   ├───robotframework
│   │   │   ├───...
│   │   │   ├───...
│   │   │   └───TESTS
│   │   │       └───...
│   │   └───...
... ...

My mkdocs.yml looks akin like:

site_name: KiSQA
site_description: mycompany
site_dir: _KiSQA_Site
docs_dir: PROJECTS
pages:
  - index.md
  - QA-Dashboard: index.md
  - Acceptance Tests:
    #- Absence Administration: AbsenceAdministration\src\test\robotframework\TESTS\README.md
    #- Activity Report: ActivityReport\src\test\robotframework\TESTS\README.md
    #- Offer Management: OfferManagement\src\test\robotframework\TESTS\README.md
    - uggly_app: uggly_app\src\test\robotframework\TESTS\test_doc.md
    - Vaadin7 Theme Demo: Vaadin7ThemeDemo\src\test\robotframework\TESTS\README.md
    - ...
   

site_author: 'Mr. Butch'
site_url: 'http://www.mycompany.com/'
theme: material
theme_dir: _KiSQA_Source
markdown_extensions:
  - admonition
  - footnotes
  - codehilite(linenums=true)
  - toc(permalink=true)
  - pymdownx.superfences
  - pymdownx.tasklist(custom_checkbox=true)
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg

extra_javascript:
  - 'KiSQA_MKDocs_Extensions\javascripts\jenkins.js'
extra_css:
  - 'KiSQA_MKDocs_Extensions\stylesheets\buttons.css'

extra:
  palette:
    primary: 'red'
    accent: 'red'
  social:
    - type: 'github'
      link: 'https://github.com/mycompany'

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions