pydoc-markdown.yml

#@ def base_url():
#@    if env.READTHEDOCS:
#@      return "https://pycertifspec.readthedocs.io/en/" + env.READTHEDOCS_VERSION + "/"
#@    else:
#@      return None
#@ end

loaders:
  - type: python
processors:
  - type: filter
  - type: smart
  - type: crossref
renderer:
  type: hugo

  markdown:
    source_linker:
      type: github
      repo: SEBv15/pycertifspec

  config:
    baseURL: #@ base_url()
    title: pycertifspec
    theme: {clone_url: "https://github.com/alex-shpak/hugo-book.git"}
  # The "book" theme only renders pages in "content/docs" into the nav.
  content_directory: content/docs
  default_preamble: {menu: main}
  pages:
    - title: Home
      name: index
      source: README.md
      directory: '..'
    - title: Getting Started
      source: 'docs/getting-started.md'
      preamble:
        weight: 2
    - title: API Documentation
      preamble:
        weight: 3
      children:
        - title: Client
          contents:
            - pycertifspec.Client.Client.*
          preamble:
            weight: 1
        - title: Motor
          contents:
            - pycertifspec.Motor.Motor.*
          preamble:
            weight: 1
        - title: Variables
          contents:
            - pycertifspec.Var.Var.*
            - pycertifspec.ArrayVar.ArrayVar.*
          preamble:
            weight: 1
        - title: SpecSocket
          contents:
            - pycertifspec.SpecSocket.*
          preamble:
            weight: 1
        - title: bluesky
          children:
            - title: Motor
              contents: 
                - pycertifspec.bluesky.Motor.Motor
                - pycertifspec.bluesky.Motor.Motor.__init__
                - pycertifspec.bluesky.Motor.Motor.configure
            - title: Counter
              contents: 
                - pycertifspec.bluesky.Counter.Counter.*
            - title: CommandDetector
              contents: 
                - pycertifspec.bluesky.CommandDetector.CommandDetector
                - pycertifspec.bluesky.CommandDetector.CommandDetector.__init__
                - pycertifspec.bluesky.CommandDetector.CommandDetector.configure
          preamble:
            weight: 9
        - title: constants
          contents:
            - pycertifspec.EventTypes.EventTypes.*
            - pycertifspec.DataTypes.DataTypes.*
            - pycertifspec.Flags.Flags.*
          preamble:
            weight: 10