mkdocs.yml

site_name: PYBOSSA Documentation
theme: 'material'
# theme: 'readthedocs'
markdown_extensions:
    - toc:
        permalink: True
    - admonition
    - smarty
    - wikilinks
    - codehilite:
        linenums: True
    # - urlize # requires: pip install git+https://github.com/r0wb0t/markdown-urlize.git
    - pymdownx.arithmatex
    - pymdownx.betterem:
        smart_enable: all
    - pymdownx.caret
    - pymdownx.critic
    - pymdownx.details
    - pymdownx.emoji:
        emoji_generator: !!python/name:pymdownx.emoji.to_svg
    - pymdownx.inlinehilite
    - pymdownx.magiclink
    - pymdownx.mark
    - pymdownx.smartsymbols
    - pymdownx.superfences
    - pymdownx.tasklist:
        custom_checkbox: True
    - pymdownx.tilde
site_favicon: 'images/favicon.ico'
extra:
  palette:
      primary: '#087da1'
      accent: '#00a889'
  font:
      text: 'Source Sans Pro'
  social:
    - type: 'github'
      link: 'https://github.com/Scifabric'
    - type: 'twitter'
      link: 'https://twitter.com/Scifabric'
repo_name: 'Scifabric/pybossa'
repo_url: 'https://github.com/Scifabric/pybossa'
copyright: 'Copyright © 2017 <a href="https://scifabric.com">Scifabric</a>'
google_analytics:
  - 'UA-49052879-1'
  - 'auto'
pages:
  - Home: 'index.md'
  - Installation:
      - 'Getting started': 'installation/gettingstarted.md'
      - 'Installing the server': 'installation/guide.md'
      - 'Configuring PYBOSSA': 'installation/configuration.md'
      - 'Deploying PYBOSSA with Nginx and uWsgi': 'installation/deployment.md'
      - 'Administrating PYBOSSA': 'installation/admin.md'
      - 'Testing PYBOSSA with Vagrant': 'installation/vagrant.md'
      - 'Security': 'installation/security.md'
  - Building a project:
      - 'Introduction': 'build/intro.md'
      - 'Quickstart: Creating a project': 'build/overview.md'
      - 'Using the command line': 'build/pbs.md'
      - 'Tutorial': 'build/tutorial.md'
      - 'Configuring the project': 'build/project_settings.md'
      - 'Real time data analysis': 'build/webhooks.md'
      - 'Data capturing: image, video or audio': 'build/capture.md'
      - 'Domain model': 'build/model.md'
  - API:
      - 'Introduction': 'api/intro.md'
      - 'Jamstack': 'api/jamstack.md'
      - 'CRUD': 'api/crud.md'
      - 'Full text search': 'api/fulltextsearch.md'
      - 'Disqus Single Sign On': 'api/sso.md'
      - 'Projects':
          - 'RESTful API':
             - 'Filtering data to several project IDs': 'api/project/filtering.md'
             - 'Statistics': 'api/project/statistics.md'
          - 'PYBOSSA endpoints':
            - 'Options': 'api/project/project.md'
      - 'Tasks':
          - 'RESTful API':
            - 'Favorites': 'api/task/favorites.md'
            - 'Excluding contributed tasks': 'api/task/participated.md'
            - 'Requesting a task': 'api/task/newtask.md'
            - 'External user ID': 'api/task/external.md'
      - 'TaskRuns':
          - 'RESTful API':
              - 'Attaching files': 'api/taskrun/intro.md'
      - 'User':
          - 'RESTful API':
             - 'Intro': 'api/user/intro.md'
             - 'Project progress': 'api/user/progress.md'
          - 'PYBOSSA endpoints':
             - 'Account': 'api/user/account.md'
             - 'Admins': 'api/user/admin.md'
      - 'Helping materials':
          - 'RESTful API':
              - 'Attaching files': 'api/helpingmaterial/intro.md'
      - 'Pages':
          - 'RESTful API':
              - 'Info': 'api/page/intro.md'
      - 'Blog posts':
          - 'RESTful API':
              - 'Attaching files': 'api/blogpost/intro.md'
      - 'Leaderboard':
         - 'PYBOSSA endpoints':
             - 'Methods': 'api/leaderboard.md'
      - 'Home page':
         - 'PYBOSSA endpoints':
             - Methods: 'api/home.md'
      - 'Announcement':
            - 'PYBOSSA endpoints':
                - Methods: 'api/announcement.md'
      - 'Categories':
            - 'PYBOSSA endpoints':
                - Methods: 'api/categories.md'
      - 'Administration':
         - 'PYBOSSA endpoints':
            - 'Dashboard': 'api/admin/dashboard.md'
            - 'Featured projects': 'api/admin/featured.md'
      - 'Help':
         - 'PYBOSSA endpoints':
            - 'Methods': 'api/help.md'
      - 'Server stats':
         - 'PYBOSSA endpoints':
            - Methods: 'api/stats.md'
  - Testing PYBOSSA with Vagrant: 'installation/vagrant.md'
  - Contributing:
      - 'General':  'contributing.md'
      - 'Translating PYBOSSA': 'translating.md'
      - 'Writing plugins': 'plugins.md'
  - GDPR: 'gdpr.md'
  - FAQ: 'faq.md'