Skip to content

Commit 41dd551

Browse files
committed
Update docs
1 parent 37f9680 commit 41dd551

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/directives/needimport.rst

+13-5
Original file line numberDiff line numberDiff line change
@@ -26,27 +26,35 @@ The directive argument can be one of the following formats:
2626
- A remote URL from which to download the ``needs.json``:
2727

2828
.. code-block:: rst
29-
29+
3030
.. needimport:: https://my_company.com/docs/remote-needs.json
3131
3232
- A local path relative to the containing document:
3333

3434
.. code-block:: rst
35-
35+
3636
.. needimport:: needs.json
3737
3838
- A local path starting with ``/`` is relative to the Sphinx source directory:
3939

4040
.. code-block:: rst
41-
41+
4242
.. needimport:: /path/to/needs.json
4343
44-
- For an absolute path, make sure to start with two ``//`` (on Linux/OSX):
44+
- For an absolute path on Linux/OSX, make sure to start with two ``//``:
4545

4646
.. code-block:: rst
47-
47+
4848
.. needimport:: //absoulte/path/to/needs.json
4949
50+
- For an absolute path on Windows, just use the normal drive letters with either forward or backward slashes:
51+
52+
.. code-block:: rst
53+
54+
.. needimport:: c:/absoulte/path/to/needs.json
55+
56+
.. needimport:: c:\absoulte\path\to\needs.json
57+
5058
Options
5159
-------
5260

0 commit comments

Comments
 (0)