| Joey Armstrong | 0c517b5 | 2023-07-07 17:29:54 -0400 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | # |
| 3 | # Configuration file for the Sphinx documentation builder. |
| 4 | # |
| 5 | # ----------------------------------------------------------------------- |
| 6 | |
| 7 | # List of patterns, relative to source directory, that match files and |
| 8 | # directories to ignore when looking for source files. |
| 9 | # This pattern also affects html_static_path and html_extra_path. |
| 10 | exclude_patterns = [ |
| 11 | '*/LICENSE.md', |
| 12 | '*/RELEASE_NOTES.md', |
| 13 | '*/vendor', |
| 14 | '.DS_Store', |
| 15 | 'Thumbs.db', |
| 16 | '_build', |
| 17 | 'voltha-go/BUILD.md', |
| 18 | 'cord-tester/venv_cord', |
| 19 | 'cord-tester/docs', |
| 20 | 'cord-tester/src', |
| 21 | 'cord-tester/README.md', |
| 22 | 'cord-tester/cord-robot/README.rst', |
| 23 | 'openolt/agent/*', |
| 24 | 'repos', |
| 25 | 'requirements.txt', |
| 26 | 'bbsim/README.md', |
| 27 | 'CODE_OF_CONDUCT.md', |
| 28 | '*/CODE_OF_CONDUCT.md', |
| 29 | |
| Joey Armstrong | 449ce7a | 2023-07-18 18:32:24 -0400 | [diff] [blame] | 30 | # ----------------------------------------------------------------------- |
| 31 | # WARNING: Roach squashing exercise ahead. |
| 32 | # External repos are sub-modules, sphinx will complain when new files added. |
| 33 | # ----------------------------------------------------------------------- |
| 34 | # Why are repos pulled in: |
| 35 | # - external linkage/direct viewing of the truth ? |
| 36 | # - generated content, documentation links ? |
| 37 | # ----------------------------------------------------------------------- |
| 38 | # Roach squash: filter files individually as they are added or found (make lint) |
| 39 | # Simple answer: bulk exclude by subdir to catch all variants. |
| 40 | # Unknown: will the subdir exclusion break doc generation or navigation ? |
| 41 | # ----------------------------------------------------------------------- |
| 42 | # 'device-management-interface/README.md', |
| 43 | |
| 44 | # ----------------------------------------------------------------------- |
| 45 | # Jump through hoops for this one: |
| 46 | # o openolt/ is an external repo |
| 47 | # o lint reported a problem with URL aliases ./BUILDING and .SECURITY |
| 48 | # o Cannot exclude by existing or literal path so resort to wildcard |
| 49 | # ----------------------------------------------------------------------- |
| 50 | |
| 51 | 'openolt/README.md', |
| 52 | # [SECURITY.md](./SECURITY.md) |
| 53 | # [BUILDING guide](BUILDING.md) |
| 54 | |
| 55 | 'openolt/olt-sw-upgrade/README.md', |
| 56 | 'voltha-helm-charts/makefiles/', |
| 57 | # 'voltha-helm-charts/makefiles/README.md', |
| 58 | 'voltha-helm-charts/makefiles/README.md', |
| 59 | # |
| 60 | 'voltha-openonu-adapter-go/templates/README.md', |
| 61 | # 'device-management-interface/docs/RpcGuidelines.md', |
| 62 | 'voltha-system-tests/patches/*', |
| 63 | 'voltha-system-tests/scripts/flog/', |
| 64 | # |
| 65 | 'voltha-system-tests/etc/README.md', |
| 66 | 'voltha-system-tests/scripts/README.md', |
| 67 | # |
| 68 | 'voltctl/MULTIPLE_STACKS.md', |
| 69 | 'voltha-system-tests/tests/data/onos-files/README.md', |
| 70 | 'voltha-openonu-adapter-go/docs/ONU_Upgrade_Notes.md', |
| 71 | |
| 72 | # WARNING: toctree contains reference to excluded document |
| 73 | # 'openolt/README.md', |
| 74 | # 'voltha-openonu-adapter-go/README.md', |
| 75 | 'repos/openolt/BUILDING.md', |
| 76 | 'repos/openolt/SECURITY.md', |
| 77 | |
| Joey Armstrong | 0c517b5 | 2023-07-07 17:29:54 -0400 | [diff] [blame] | 78 | # Ignore all: |
| 79 | 'makefiles', |
| 80 | '__pycache__', |
| 81 | '**/__pycache__', # generated - faster traversal |
| 82 | '.venv', |
| 83 | '**/.venv', # external virtual env |
| 84 | |
| 85 | # Revisit: one directory pattern is sufficient. |
| 86 | # makefiles/virtualenv.mk normalizes all of this |
| Joey Armstrong | 449ce7a | 2023-07-18 18:32:24 -0400 | [diff] [blame] | 87 | '**/doc_venv', |
| Joey Armstrong | 0c517b5 | 2023-07-07 17:29:54 -0400 | [diff] [blame] | 88 | '**/venv_docs', |
| 89 | '**/virtualenv', |
| 90 | '**/vst_venv', |
| Joey Armstrong | 449ce7a | 2023-07-18 18:32:24 -0400 | [diff] [blame] | 91 | '**/venv_cord', |
| Joey Armstrong | 0c517b5 | 2023-07-07 17:29:54 -0400 | [diff] [blame] | 92 | ] |
| 93 | |
| 94 | # [EOF] |