mkdocs.yml 4.5 KB

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