Skip to content

Commit

Permalink
fix broken API reference cross-references to manual
Browse files Browse the repository at this point in the history
  • Loading branch information
xflr6 committed Jun 3, 2022
1 parent 4aa4d24 commit 3721202
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 25 deletions.
24 changes: 3 additions & 21 deletions docs/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,61 +6,43 @@ User Guide

.. include:: installation.rst


.. include:: basic_usage.rst


.. include:: formats.rst


.. include:: piped_output.rst


.. include:: jupyter_notebooks.rst


.. include:: styling.rst


.. _Attributes:
.. include:: attributes.rst


.. _Ports:
.. include:: node_ports.rst


.. _Escapes:

.. include:: escapes.rst


.. _Quoting:

.. include:: quoting.rst


.. _Subgraphs:
.. include:: subgraphs_and_clusters.rst


.. _Engines:

.. include:: engines.rst


.. include:: neato_no_op.rst


.. include:: unflatten.rst


.. include:: custom_dot.rst


.. _Sources:

.. include:: raw_dot.rst


.. include:: existing_files.rst


.. include:: integration_with_viewers.rst
8 changes: 4 additions & 4 deletions graphviz/dot.py
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ def edge(self, tail_name: str, head_name: str,
The ``tail_name`` and ``head_name`` strings are separated
by (optional) colon(s) into ``node`` name, ``port`` name,
and ``compass`` (e.g. ``sw``).
See `details in the User Guide <ports>`.
See :ref:`details in the User Guide <Ports>`.
"""
tail_name = self._quote_edge(tail_name)
head_name = self._quote_edge(head_name)
Expand All @@ -235,7 +235,7 @@ def edges(self, tail_head_iter) -> None:
The ``tail_name`` and ``head_name`` strings are separated
by (optional) colon(s) into ``node`` name, ``port`` name,
and ``compass`` (e.g. ``sw``).
See `details in the User Guide <ports>`.
See :ref:`details in the User Guide <Ports>`.
"""
edge = self._edge_plain
quote = self._quote_edge
Expand All @@ -252,7 +252,7 @@ def attr(self, kw: typing.Optional[str] = None,
(``None`` or ``'graph'``, ``'node'``, ``'edge'``).
attrs: Attributes to be set (must be strings, may be empty).
See the `usage examples in the User Guide <attributes>`.
See the :ref:`usage examples in the User Guide <Attributes>`.
"""
if kw is not None and kw.lower() not in ('graph', 'node', 'edge'):
raise ValueError('attr statement must target graph, node, or edge:'
Expand Down Expand Up @@ -294,7 +294,7 @@ def subgraph(self, graph=None,
body: Verbatim lines to add to the subgraph ``body``
(``with``-block use).
See the `usage examples in the User Guide <subgraphs>`.
See the :ref:`usage examples in the User Guide <Subgraphs>`.
When used as a context manager, the returned new graph instance
uses ``strict=None`` and the parent graph's values
Expand Down

0 comments on commit 3721202

Please sign in to comment.