openboxes/mkdocs.yml at develop · andualem/openboxes · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
site_name: OpenBoxes
site_description:
site_author: Justin Miranda
theme: 'readthedocs'
repo_url: https://github.com/openboxes/openboxes
#include_search: true
#use_absolute_urls: true
use_directory_urls: true
copyright: Copyright &copy; 2010-2018, OpenBoxes
google_analytics: ['UA-37396941-2', 'openboxes.com']
markdown_extensions:
  - admonition
  - footnotes
  - tables

pages:
- Home: 'index.md'
- About:
    - 'Benefits': 'about/benefits.md'
    - 'Considerations': 'about/considerations.md'
    - 'Release Notes': 'about/release-notes.md'
- Installation Guide:
    - 'Overview': 'installation/index.md'
    - 'Install on Ubuntu':
      - 'Install on Ubuntu 14.04': 'installation/ubuntu1404.md'
      - 'Install on Ubuntu 16.04': 'installation/ubuntu1604.md'
    - 'Install on Mac OS': 'installation/macos.md'
    - 'Install on Windows': 'installation/windows.md'
    - 'Upgrading': 'upgrading/index.md'

- Configuration Guide:
    - 'General': 'configuration/configuration.md'
    - 'Database': 'configuration/database.md'
    - 'Email': 'configuration/email.md'
    - 'Application': 'configuration/application.md'
    - 'Example': 'configuration/example.md'

- User Guide: 'user-guide/index.md'
- Developer Guide:
    - 'Introduction': 'developer-guide/index.md'
    - 'Getting Started': 'developer-guide/getting-started.md'
    - 'Contributing': 'developer-guide/contributing.md'
    - 'Syncing a Fork': 'developer-guide/syncing-a-fork.md'
    - 'Tagging a Release': 'developer-guide/tagging.md'

- REST API Guide:
    - 'Overview': 'api-guide/index.md'
    - 'Getting Started': 'api-guide/getting-started.md'
    - 'Generic API': 'api-guide/generic.md'
    - 'Custom API':
        - 'Core':
            - 'Identifiers': 'api-guide/identifier.md'
            - 'Internal Locations': 'api-guide/internalLocation.md'
            - 'Localizations': 'api-guide/localization.md'
            - 'Locations': 'api-guide/location.md'
            - 'Lookup': 'api-guide/lookup.md'
        - 'Products':
            - 'Categories': 'api-guide/category.md'
            - 'Products': 'api-guide/product.md'
        - 'Stock Movements':
            - 'Stock Movement': 'api-guide/stockMovement.md'
            - 'Stock Movement Item': 'api-guide/stockMovementItem.md'
            - 'Stock Movement Status': 'api-guide/stockMovementStatus.md'
            - 'Putaway': 'api-guide/putaway.md'
            - 'Receiving': 'api-guide/receiving.md'

- Support: 'support/index.md'