Skip to content

The CLI commands do not get their own entries when building the docs #92

@mikel-brostrom

Description

@mikel-brostrom

The CLI commands do not get their own entries when building the docs. This is how it looks right now:

Image

I want:

cli
 - track
 - evaluation
 - tune

The mkdocs.yml contents:

# mkdocs.yml
site_name: BoxMot
theme:
  name: material
  # turn on both section grouping and global expand
  features:
    - navigation.sections
    - navigation.expand

markdown_extensions:
    - mkdocs-click

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          setup_commands:
            - import sys; sys.path.insert(0, ".")
          options:
            selection:
              members: "__all__"
              filters:
                - "!^update$"

nav:
  - Home: index.md

  - CLI: cli.md

  - Trackers:
      - ByteTrack:    api/trackers/bytetrack.md
      - BotSort:      api/trackers/botsort.md
      - StrongSort:   api/trackers/strongsort.md
      - OcSort:       api/trackers/ocsort.md
      - DeepOcSort:   api/trackers/deepocsort.md
      # - HybridSort:   api/trackers/hybridsort.md
      - BoostTrack:   api/trackers/boosttrack.md

The contents in the cli.md file

# boxmot

::: mkdocs-click
    :module: boxmot.engine.cli
    :command: boxmot

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    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