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

Single-page documentation (\wout toctree) #180

Closed
chrisjsewell opened this issue May 17, 2020 · 3 comments
Closed

Single-page documentation (\wout toctree) #180

chrisjsewell opened this issue May 17, 2020 · 3 comments

Comments

@chrisjsewell
Copy link

chrisjsewell commented May 17, 2020

In https://sphinx-panels.readthedocs.io I have some simple documentation, that is currently all included in the index.rst. This works fine for the sphinx_rtd_theme, but if I just change the theme to pydata_sphinx_theme I get:

Theme error:
An error happened in rendering the page index.
Reason: AttributeError("'NoneType' object has no attribute 'children'")
make: *** [html] Error 2

At a minimum, the error handling here should be more informative, if there is not toctree data.

If I try adding a self-referencing toctree in index.rst, e.g.

.. toctree::
    
    index

It builds, but I get self-referencing warnings (see sphinx-doc/sphinx#7410), so that's not ideal.

This would also be relevant to #90 (cc'ing @choldgraf )

@choldgraf
Copy link
Collaborator

I think that I've fixed this one in sphinx-book-theme since it has a single page version that works pretty well. I can try to figure out where that fix was and upstream it

@12rambau
Copy link
Collaborator

Any movment on this one ? or are we simply relying on sphinx-book-theme for single page documentation ?

@choldgraf
Copy link
Collaborator

We had cleaned up our build code a while back, and I suspect that this issue was resolved then. I just tried re-building these docs after deleting the toctrees from our index.rst file, and it built fine, so I think we can close this!

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