mkdocs.yml 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. site_name: NetBox Documentation
  2. site_dir: netbox/project-static/docs
  3. site_url: https://netbox.readthedocs.io/
  4. repo_name: netbox-community/netbox
  5. repo_url: https://github.com/netbox-community/netbox
  6. theme:
  7. name: material
  8. icon:
  9. repo: fontawesome/brands/github
  10. palette:
  11. - scheme: default
  12. toggle:
  13. icon: material/lightbulb-outline
  14. name: Switch to Dark Mode
  15. - scheme: slate
  16. toggle:
  17. icon: material/lightbulb
  18. name: Switch to Light Mode
  19. extra:
  20. social:
  21. - icon: fontawesome/brands/github
  22. link: https://github.com/netbox-community/netbox
  23. - icon: fontawesome/brands/slack
  24. link: https://netdev.chat/
  25. extra_css:
  26. - extra.css
  27. markdown_extensions:
  28. - admonition
  29. - attr_list
  30. - markdown_include.include:
  31. base_path: 'docs/'
  32. headingOffset: 1
  33. - pymdownx.emoji:
  34. emoji_index: !!python/name:materialx.emoji.twemoji
  35. emoji_generator: !!python/name:materialx.emoji.to_svg
  36. - pymdownx.superfences
  37. - pymdownx.tabbed
  38. nav:
  39. - Introduction: 'index.md'
  40. - Installation:
  41. - Installing NetBox: 'installation/index.md'
  42. - 1. PostgreSQL: 'installation/1-postgresql.md'
  43. - 2. Redis: 'installation/2-redis.md'
  44. - 3. NetBox: 'installation/3-netbox.md'
  45. - 4. Gunicorn: 'installation/4-gunicorn.md'
  46. - 5. HTTP Server: 'installation/5-http-server.md'
  47. - 6. LDAP (Optional): 'installation/6-ldap.md'
  48. - Upgrading NetBox: 'installation/upgrading.md'
  49. - Migrating to systemd: 'installation/migrating-to-systemd.md'
  50. - Configuration:
  51. - Configuring NetBox: 'configuration/index.md'
  52. - Required Settings: 'configuration/required-settings.md'
  53. - Optional Settings: 'configuration/optional-settings.md'
  54. - Core Functionality:
  55. - IP Address Management: 'core-functionality/ipam.md'
  56. - VLAN Management: 'core-functionality/vlans.md'
  57. - Sites and Racks: 'core-functionality/sites-and-racks.md'
  58. - Devices and Cabling: 'core-functionality/devices.md'
  59. - Device Types: 'core-functionality/device-types.md'
  60. - Virtualization: 'core-functionality/virtualization.md'
  61. - Service Mapping: 'core-functionality/services.md'
  62. - Circuits: 'core-functionality/circuits.md'
  63. - Power Tracking: 'core-functionality/power.md'
  64. - Tenancy: 'core-functionality/tenancy.md'
  65. - Customization:
  66. - Custom Fields: 'customization/custom-fields.md'
  67. - Custom Validation: 'customization/custom-validation.md'
  68. - Custom Links: 'customization/custom-links.md'
  69. - Export Templates: 'customization/export-templates.md'
  70. - Custom Scripts: 'customization/custom-scripts.md'
  71. - Reports: 'customization/reports.md'
  72. - Additional Features:
  73. - Change Logging: 'additional-features/change-logging.md'
  74. - Context Data: 'models/extras/configcontext.md'
  75. - Journaling: 'additional-features/journaling.md'
  76. - NAPALM: 'additional-features/napalm.md'
  77. - Prometheus Metrics: 'additional-features/prometheus-metrics.md'
  78. - Tags: 'models/extras/tag.md'
  79. - Webhooks: 'additional-features/webhooks.md'
  80. - Plugins:
  81. - Using Plugins: 'plugins/index.md'
  82. - Developing Plugins: 'plugins/development.md'
  83. - Administration:
  84. - Permissions: 'administration/permissions.md'
  85. - Housekeeping: 'administration/housekeeping.md'
  86. - Replicating NetBox: 'administration/replicating-netbox.md'
  87. - NetBox Shell: 'administration/netbox-shell.md'
  88. - REST API:
  89. - Overview: 'rest-api/overview.md'
  90. - Filtering: 'rest-api/filtering.md'
  91. - Authentication: 'rest-api/authentication.md'
  92. - GraphQL API:
  93. - Overview: 'graphql-api/overview.md'
  94. - Development:
  95. - Introduction: 'development/index.md'
  96. - Getting Started: 'development/getting-started.md'
  97. - Style Guide: 'development/style-guide.md'
  98. - Models: 'development/models.md'
  99. - Adding Models: 'development/adding-models.md'
  100. - Extending Models: 'development/extending-models.md'
  101. - Signals: 'development/signals.md'
  102. - Application Registry: 'development/application-registry.md'
  103. - User Preferences: 'development/user-preferences.md'
  104. - Web UI: 'development/web-ui.md'
  105. - Release Checklist: 'development/release-checklist.md'
  106. - Release Notes:
  107. - Version 3.0: 'release-notes/version-3.0.md'
  108. - Version 2.11: 'release-notes/version-2.11.md'
  109. - Version 2.10: 'release-notes/version-2.10.md'
  110. - Version 2.9: 'release-notes/version-2.9.md'
  111. - Version 2.8: 'release-notes/version-2.8.md'
  112. - Version 2.7: 'release-notes/version-2.7.md'
  113. - Version 2.6: 'release-notes/version-2.6.md'
  114. - Version 2.5: 'release-notes/version-2.5.md'
  115. - Version 2.4: 'release-notes/version-2.4.md'
  116. - Version 2.3: 'release-notes/version-2.3.md'
  117. - Version 2.2: 'release-notes/version-2.2.md'
  118. - Version 2.1: 'release-notes/version-2.1.md'
  119. - Version 2.0: 'release-notes/version-2.0.md'