Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
felixchenier opened this issue Apr 28, 2022 · 4 comments

Comments

@felixchenier
Copy link

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

@welcome
Copy link

welcome bot commented Apr 28, 2022

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

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! 🎉

@mmcky
Copy link
Member

mmcky commented Apr 29, 2022

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

cc: @chrisjsewell

@welcome
Copy link

welcome bot commented Apr 29, 2022

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

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! 🎉

@mmcky mmcky transferred this issue from executablebooks/jupyter-book Apr 29, 2022
@mmcky mmcky changed the title Issue on page /advanced/developers.html Issue on page /advanced/developers.html of Jupyter Book Documentation Apr 29, 2022
@agoose77
Copy link
Collaborator

Related to #36

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants