sphinx-external-toc icon indicating copy to clipboard operation
sphinx-external-toc copied to clipboard

Issue on page /advanced/developers.html of Jupyter Book Documentation

Open felixchenier opened this issue 2 years ago • 4 comments

Good morning

I don't know if you run in the same problem, but following your instructions for including my package documentation, I get this message:

WARNING: toctree directive not expected with external-toc [etoc.toctree]

This comes from the toctree directive in my markdown file:

# Classes

```{eval-rst}

.. currentmodule:: kineticstoolkit

.. autosummary::
    :template: custom_class_template.rst
    :recursive:
    :toctree: api

    TimeSeries
    TimeSeriesEvent
    Player
```

I still need this toctree entry because otherwise the package documentation is not built. Do you know what should be the best practice here? I'd be happy to silence this warning since this method works, but I don't know how and if I should.

Thanks

felixchenier avatar Apr 28 '22 13:04 felixchenier

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

welcome[bot] avatar Apr 28 '22 13:04 welcome[bot]

Linking this issue to https://github.com/executablebooks/sphinx-external-toc as this is the extension driving that warning.

cc: @chrisjsewell

mmcky avatar Apr 29 '22 03:04 mmcky

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

welcome[bot] avatar Apr 29 '22 03:04 welcome[bot]

Related to #36

agoose77 avatar Jul 12 '22 10:07 agoose77