Skip to content

Commit

Permalink
Improve doc formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
mpenning committed May 27, 2019
1 parent bf8926f commit 1f3a491
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 20 deletions.
2 changes: 1 addition & 1 deletion sphinx-doc/api_IOSCfgLine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
ciscoconfparse.models_cisco.IOSCfgLine Object
---------------------------------------------

.. autoclass:: models_cisco.IOSCfgLine
.. autoclass:: ciscoconfparse.models_cisco.IOSCfgLine
:members:
:inherited-members:
2 changes: 1 addition & 1 deletion sphinx-doc/api_IOSIntfLine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
ciscoconfparse.models_cisco.IOSIntfLine Object
----------------------------------------------

.. autoclass:: models_cisco.IOSIntfLine
.. autoclass:: ciscoconfparse.models_cisco.IOSIntfLine
:members:
:inherited-members:
10 changes: 5 additions & 5 deletions sphinx-doc/api_ccp_util.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,25 @@
ciscoconfparse.ccp_util Classes and Methods
-------------------------------------------

.. autoclass:: ccp_util.IPv4Obj
.. autoclass:: ciscoconfparse.ccp_util.IPv4Obj
:members:
:undoc-members:
:inherited-members:

.. autoclass:: ccp_util.IPv6Obj
.. autoclass:: ciscoconfparse.ccp_util.IPv6Obj
:members:
:undoc-members:
:inherited-members:

.. autoclass:: ccp_util.CiscoRange
.. autoclass:: ciscoconfparse.ccp_util.CiscoRange
:members:
:undoc-members:
:inherited-members:

.. autoclass:: ccp_util.DNSResponse
.. autoclass:: ciscoconfparse.ccp_util.DNSResponse
:members:
:undoc-members:
:inherited-members:

.. autofunction:: ccp_util.dns_query
.. autofunction:: ciscoconfparse.ccp_util.dns_query

13 changes: 0 additions & 13 deletions sphinx-doc/legacy_syntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,19 +193,6 @@ If you *do* want the children (recursively), then use
['policy-map QOS_1', ' class GOLD', ' priority percent 10', ' class SILVER', ' bandwidth 30', ' random-detect', ' class default']
CiscoConfParse options
~~~~~~~~~~~~~~~~~~~~~~

Several of :class:`~ciscoconfparse.CiscoConfParse`'s functions support one of these options:

- exactmatch
- ignore_ws

:option:`exactmatch` - This can either be :const:`True` or :const:`False` (the default). When :option:`exactmatch` is set :const:`True`, CiscoConfParse requires an exact match of the whole string (instead of a sub-string match, which is the default).

:option:`ignore_ws` - This can either be :const:`True` or :const:`False` (the default). When :option:`ignore_ws` is set :const:`True`, CiscoConfParse will ignore differences in whitespace between the query string and the IOS configuration.

Not all functions support the options above; please consult the API documentation for specifics.
Checking Passwords
------------------------------
Expand Down

0 comments on commit 1f3a491

Please sign in to comment.