mkdocs.yml 4.0 KB

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