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

Orphaned page #18

Open
bjones1 opened this issue Jul 20, 2021 · 4 comments
Open

Orphaned page #18

bjones1 opened this issue Jul 20, 2021 · 4 comments

Comments

@bjones1
Copy link
Contributor

bjones1 commented Jul 20, 2021

The page added by #17 isn't referenced in a toctree anywhere -- where does it belong?

@dsanders12
Copy link

Could you please clarify what this issue is?

@bjones1
Copy link
Contributor Author

bjones1 commented Aug 24, 2021

The toctree directive in Sphinx allows Sphinx to create a web of pages. Each document should be referenced via a toctree or link something in the web. However, _sources/Containers/dynamic_supp.rst isn't included anywhere, so it's difficult for readers to find this page. It should be included in a toctree.

@sreynit02
Copy link
Contributor

sreynit02 commented Sep 30, 2021

@bnmnetp There is no change needed because all the questions in _sources/Containers/dynamic_supp.rst are being pulled into _sources/Containers/dynamic.rst.
Confirmed by @Bryar-Frank

@bjones1
Copy link
Contributor Author

bjones1 commented Sep 30, 2021

@sreynit02 and @Bryar-Frank, thanks for checking! To avoid warnings [1] during the build process, this page should be marked as an orphan; I'd also suggest adding a bit of text at the top of this page explaining that this page contains questions referenced by dynamic problems in dynamic.rst. Something like...

:orphan:

.. note::
    This page contains problems used by dynamic problems in :any:`dynamic`; it's not otherwise used.

...placed at the top of the file. @sreynit02, would you mind creating a PR to fix this?

Thanks!


[1] The warning I get when building the book is books\overview\_sources\Containers\dynamic_supp.rst: WARNING: document isn't included in any toctree.

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