mkdocs.yml

site_name: TensorX Documentation


# Repository
repo_name: davidenunes/tensorx
repo_url: https://github.com/davidenunes/tensorx
edit_uri: ""

# Copyright
copyright: Copyright © 2016 - 2020 Davide Nunes

docs_dir: "docs/sources"

markdown_extensions:
  - admonition
  - codehilite:
      use_pygments: true
      noclasses: true
      pygments_style: tango
  - pymdownx.arithmatex


plugins:
  - search

extra_css:
  - 'assets/css/extra.css'

# for mathjax
extra_javascript:
  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'

theme:
  name: 'material'
  custom_dir: 'docs/theme'
  palette:
    primary: 'white'
  logo: 'assets/images/logo_full.svg'
  favicon: 'assets/images/tx.png'
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - instant
nav:
  - Home: index.md
  - Getting Started:
      - Installation: start/install.md
      - Tutorial: start/tutorial.md
  - API:
    - layers:
        - Overview: api/layers/index.md
        - Layer: api/layers/Layer.md
        - Lambda: api/layers/Lambda.md
        - Input: api/layers/Input.md
        - Linear: api/layers/Linear.md
        - Lookup: api/layers/Lookup.md
        - Activation: api/layers/Activation.md
        - Module: api/layers/Module.md
        - MHAttention: api/layers/MHAttention.md
        - Recurrent Layers:
            - RNN: api/layers/rnn/RNN.md
            - RNNBaseCell: api/layers/rnn/BaseRNNCell.md
            - RNNCell: api/layers/rnn/RNNCell.md
            - GRUCell: api/layers/rnn/GRUCell.md
            - LSTMCell: api/layers/rnn/LSTMCell.md
        - Utils:
            - LayerState: api/layers/utils/LayerState.md
            - LayerConfig: api/layers/utils/LayerConfig.md
    - ops: api/ops.md
    - math: api/math.md
    - init: api/init.md
    - activation: api/activation.md
    - loss: api/loss.md
    - metrics: api/metrics.md
    - utils:
        - Graph: api/utils/Graph.md
    - train:
        - Model: api/train/Model.md
        - Callback: api/train/Callback.md

  - Contributing: contributing.md