search

openwisp / openwisp-utils

Python and Django utilities shared between different openwisp modules
https://openwisp.io/docs/dev/utils/
BSD 3-Clause "New" or "Revised" License
74 stars 72 forks source link

[bug] ReStructuredText failing for sphinx syntax #147

Closed nemesifier closed 4 years ago

nemesifier commented 4 years ago

The ReStructuredText check fails in those repos which are using sphinx, eg: openwisp-radius.

- <string>:43: (ERROR/3) Unknown directive type "toctree".
- 
- .. toctree::
-    :maxdepth: 2
-    :caption: Contents:
- 
-    /developer/setup
-    /developer/freeradius
-    /user/settings
-    /user/management_commands
-    /user/importing_users
-    /user/generating_users
-    /user/enforcing_limits
-    /user/registration
-    /user/social_login
-    /user/api
-    /developer/how_to_extend
-    /developer/contributing
-    /general/goals

@KapilBansal320 can we selectively disable some errors?

devkapilbansal commented 4 years ago

I will try to find a solution for that.

devkapilbansal commented 4 years ago

The ReStructuredText check fails in those repos which are using sphinx, eg: openwisp-radius.

- <string>:43: (ERROR/3) Unknown directive type "toctree".
- 
- .. toctree::
-    :maxdepth: 2
-    :caption: Contents:
- 
-    /developer/setup
-    /developer/freeradius
-    /user/settings
-    /user/management_commands
-    /user/importing_users
-    /user/generating_users
-    /user/enforcing_limits
-    /user/registration
-    /user/social_login
-    /user/api
-    /developer/how_to_extend
-    /developer/contributing
-    /general/goals

@KapilBansal320 can we selectively disable some errors?

@nemesisdesign Please review pull request #148 for this.