Skip to content

Commit eccdf8c

Browse files
committed
Add note about Sphinx warnings
1 parent a45d5e6 commit eccdf8c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,14 @@ To build and develop the documentation locally, make sure sphinx is available (w
114114
> make livehtml
115115
```
116116

117+
> Note: You will see some warnings along the lines of
118+
> ```
119+
> WARNING: duplicate object description of pystac.Collection.id,
120+
> other instance in api, use :noindex: for one of them
121+
> ```
122+
> for some of the
123+
> classes. This is expected due to [sphinx-doc/sphinx#8664](https://github.com/sphinx-doc/sphinx/issues/8664).
124+
117125
Use 'make' without arguments to see a list of available commands.
118126
119127
__Note__: `nbsphinx` requires that a local `pystac` is installed; use `pip install -e .`.

0 commit comments

Comments
 (0)