mkdocs.yml 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. site_name: NetBox
  2. theme: readthedocs
  3. repo_url: https://github.com/netbox-community/netbox
  4. pages:
  5. - Introduction: 'index.md'
  6. - Installation:
  7. - Installing NetBox: 'installation/index.md'
  8. - 1. PostgreSQL: 'installation/1-postgresql.md'
  9. - 2. NetBox: 'installation/2-netbox.md'
  10. - 3. HTTP Daemon: 'installation/3-http-daemon.md'
  11. - 4. LDAP (Optional): 'installation/4-ldap.md'
  12. - Upgrading NetBox: 'installation/upgrading.md'
  13. - Migrating to Python3: 'installation/migrating-to-python3.md'
  14. - Configuration:
  15. - Configuring NetBox: 'configuration/index.md'
  16. - Required Settings: 'configuration/required-settings.md'
  17. - Optional Settings: 'configuration/optional-settings.md'
  18. - Core Functionality:
  19. - IP Address Management: 'core-functionality/ipam.md'
  20. - VLANs: 'core-functionality/vlans.md'
  21. - Sites and Racks: 'core-functionality/sites-and-racks.md'
  22. - Devices: 'core-functionality/devices.md'
  23. - Virtual Machines: 'core-functionality/virtual-machines.md'
  24. - Services: 'core-functionality/services.md'
  25. - Circuits: 'core-functionality/circuits.md'
  26. - Secrets: 'core-functionality/secrets.md'
  27. - Tenancy: 'core-functionality/tenancy.md'
  28. - Additional Features:
  29. - Tags: 'additional-features/tags.md'
  30. - Custom Fields: 'additional-features/custom-fields.md'
  31. - Context Data: 'additional-features/context-data.md'
  32. - Export Templates: 'additional-features/export-templates.md'
  33. - Graphs: 'additional-features/graphs.md'
  34. - Reports: 'additional-features/reports.md'
  35. - Webhooks: 'additional-features/webhooks.md'
  36. - Change Logging: 'additional-features/change-logging.md'
  37. - Caching: 'additional-features/caching.md'
  38. - Prometheus Metrics: 'additional-features/prometheus-metrics.md'
  39. - Administration:
  40. - Replicating NetBox: 'administration/replicating-netbox.md'
  41. - NetBox Shell: 'administration/netbox-shell.md'
  42. - API:
  43. - Overview: 'api/overview.md'
  44. - Authentication: 'api/authentication.md'
  45. - Working with Secrets: 'api/working-with-secrets.md'
  46. - Examples: 'api/examples.md'
  47. - Development:
  48. - Introduction: 'development/index.md'
  49. - Style Guide: 'development/style-guide.md'
  50. - Utility Views: 'development/utility-views.md'
  51. - Extending Models: 'development/extending-models.md'
  52. - Release Checklist: 'development/release-checklist.md'
  53. markdown_extensions:
  54. - admonition: