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.

Sign up for GitHub

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

Jump to bottom

[DRAFT] Upgrade to JupyterBook #209

Draft
wants to merge 34 commits into
base: main
Choose a base branch
from
Draft

[DRAFT] Upgrade to JupyterBook #209

wants to merge 34 commits into from

Conversation

jnywong
Copy link
Member

@jnywong jnywong commented Mar 5, 2024 •
edited

@jnywong jnywong self-assigned this Mar 5, 2024
@jnywong jnywong marked this pull request as draft March 5, 2024 15:24
@jnywong jnywong mentioned this pull request Mar 5, 2024
Open
1 task
@jnywong
Copy link
Member Author

jnywong commented Mar 7, 2024

toctree directives from Sphinx external-toc gives the warning

/home/jovyan/docs/about/service/index.md:22: WARNING: toctree directive not expected with external-toc [etoc.toctree]
/home/jovyan/docs/about/service/index.md:45: WARNING: toctree directive not expected with external-toc [etoc.toctree]
/home/jovyan/docs/about/service/index.md:67: WARNING: toctree directive not expected with external-toc [etoc.toctree]

tableofcontents and contents directives from Jupyter Book docs are not sufficient since they refer to toctrees defined within the same page rather than cross-referencing to different pages.

@jnywong
Copy link
Member Author

jnywong commented Mar 13, 2024

toctree directives from Sphinx external-toc gives the warning

/home/jovyan/docs/about/service/index.md:22: WARNING: toctree directive not expected with external-toc [etoc.toctree]
/home/jovyan/docs/about/service/index.md:45: WARNING: toctree directive not expected with external-toc [etoc.toctree]
/home/jovyan/docs/about/service/index.md:67: WARNING: toctree directive not expected with external-toc [etoc.toctree]

tableofcontents and contents directives from Jupyter Book docs are not sufficient since they refer to toctrees defined within the same page rather than cross-referencing to different pages.

@agoose77 has reassured me that the toctree directive is safe to use in Jupyter Book for now if we are explicit about read-only cases.

@jnywong
Copy link
Member Author

jnywong commented Mar 20, 2024 •
edited

Running the Jupyter Book linkechecker gives

$ jb build . -q --builder linkcheck
Running Jupyter-Book v1.0.0
Source Folder: /home/jovyan/docs
Config Path: /home/jovyan/docs/_config.yml
Output Path: /home/jovyan/docs/_build/html
/home/jovyan/docs/about/distributions/index.md:19: WARNING: broken link: https://docs.2i2c.org/en/latest/admin/howto/content.html (404 Client Error: Not Found for url: https://docs.2i2c.org/admin/howto/content.html)
/home/jovyan/docs/about/distributions/index.md:19: WARNING: broken link: https://docs.2i2c.org/en/latest/admin/howto/data.html (404 Client Error: Not Found for url: https://docs.2i2c.org/admin/howto/data.html)
/home/jovyan/docs/admin/howto/control-user-server.md:29: WARNING: broken link: https://github.com/jupyterlab/rtc (404 Client Error: Not Found for url: https://github.com/jupyterlab/rtc)
/home/jovyan/docs/admin/howto/manage-users.md:147: WARNING: broken link: https://infrastructure.2i2c.org/en/latest/howto/configure/auth-management.html#switch-identity-providers-or-user-accounts (404 Client Error: Not Found for url: https://infrastructure.2i2c.org/howto/configure/auth-management.html)
/home/jovyan/docs/topic/cloud-costs.md:65: WARNING: broken link: https://nbviewer.jupyter.org/github/berkeley-dsep-infra/datahub-usage-analysis/blob/master/notebooks/03-visualize-cost-and-usage.ipynb (404 Client Error: Not Found for url: https://nbviewer.org/github/berkeley-dsep-infra/datahub-usage-analysis/blob/master/notebooks/03-visualize-cost-and-usage.ipynb)
/home/jovyan/docs/about/service/comparison.md:476: WARNING: broken link: https://noteable.io/ (HTTPSConnectionPool(host='noteable.io', port=443): Max retries exceeded with url: / (Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self-signed certificate in certificate chain (_ssl.c:1007)'))))
(topic/cloud-costs: line   65) broken    https://nbviewer.jupyter.org/github/berkeley-dsep-infra/datahub-usage-analysis/blob/master/notebooks/03-visualize-cost-and-usage.ipynb - 404 Client Error: Not Found for url: https://nbviewer.org/github/berkeley-dsep-infra/datahub-usage-analysis/blob/master/notebooks/03-visualize-cost-and-usage.ipynb
(about/service/comparison: line  476) broken    https://engagelively.com/ - HTTPSConnectionPool(host='engagelively.com', port=443): Max retries exceeded with url: / (Caused by ConnectTimeoutError(<urllib3.connection.HTTPSConnection object at 0x7fd4c41fe6b0>, 'Connection to engagelively.com timed out. (connect timeout=None)'))
rediraffe: Redirect generation skipped for linkcheck builders.
build finished with problems.

===============================================================================

Building your book, returns a non-zero exit code (1). Look above for the cause.

===============================================================================

@jnywong
Fix links
2db1e1c 
noteable.io no longer exists
@jnywong
Fix links
835c18d 
Jupyter Real-Time Collaboration has since released.
@jnywong
Fix links
4d899ff
@jnywong
Fix links
caae3f6 
Branch has switched from master to main.
@jnywong
Test feature-table.py in RTD preview
b5ccd32
@jnywong
Fix typo
17689fd
@jnywong
Remove feature table script from conf.py
89a9d6c
@jnywong jnywong mentioned this pull request Mar 20, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jnywong jnywong

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[EPIC] Port existing Hub Service Guide content to Jupyter Book
1 participant
@jnywong