pydoc-markdown.yml

#@ def base_url():
#@    if env.READTHEDOCS:
#@      return "https://spock-instability.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: dtamayo/spock

  config:
    baseURL: #@ base_url()
    title: spock
    theme: {clone_url: "https://github.com/alex-shpak/hugo-book.git"}
  # The "book" theme only renders pages in "content/docs" into the nav.

  build_directory: docs/build
  content_directory: content/docs

  default_preamble: {menu: main}
  pages:
    - title: Home
      name: index
      source: README.md
      directory: '..'
    - title: Getting started
      name: getting-started
      source: docs/start.md
      preamble: {weight: 1}
    - title: Feature Classifier API
      contents:
        - spock.featureclassifier.FeatureClassifier
        - spock.featureclassifier.FeatureClassifier.*
    - title: Nbody Regressor API
      contents:
        - spock.nbodyregressor.NbodyRegressor
        - spock.nbodyregressor.NbodyRegressor.*
    - title: Deep Regressor API
      contents:
        - spock.regression.DeepRegressor
        - spock.regression.DeepRegressor.predict_instability_time
        - spock.regression.DeepRegressor.predict_stable
        - spock.regression.DeepRegressor.sample_instability_time
      preamble: {weight: 2}