Comments (8)
+1 It would be really useful to produce html suitable for readthedocs from just rst!
from sphinxcontrib-jupyter.
Thanks @GavinHuttley in principle the contents of _build/website/jupyter_html
should work with readthedocs
as it would be hosted. However currently not sure how to change rtd
to run a different command to make html
and copy the results from a different location.
- look at potential for
readthedocs
integration
from sphinxcontrib-jupyter.
@DrDrij what would be invovled in generating html
pages that can be opened and styled (without needing a server to be running)?
from sphinxcontrib-jupyter.
Hmm.
- All internal links need to be relative
- All internal links need to include a full file path and extension (
<a href="../getting_started_julia/julia_environment.html">next lecture</a>
) - Links to scripts and stylesheets need to be relative (
<link rel="stylesheet" href="../../_static/css/julia.css?v=1.0">
)
Easy if all the site pages are at the same level, a lot more challenging if there are nested directories.
from sphinxcontrib-jupyter.
Thanks @DrDrij that is a useful list. So we mainly need a server due to the use of root
level referencing to support nested folders.
To implement this the extension would require better management and tracking of paths
in the extension for the nested folder case. Something we are looking into for improvements in managing static assets.
from sphinxcontrib-jupyter.
@GavinHuttley this probably won't get looked at in great detail until we undertake the refactor
in mid November 2019. Hope that is OK.
from sphinxcontrib-jupyter.
Thanks for asking, I need to release my project earlier than that so will continue with the current mix of rst and ipynb (which currently relies on nbsphinx for integrating of the two types). But I look forward to consolidating on rst so I can take advantage of its capabilities.
I will just make the comment that sphinx includes the pathto
jinja2
macro that can be used for establishing relative links (that was in a comment on my junix
pull request). The issue I identified was that this project is usingnbconvert
for processing the templates, so pathto
is not in the namespace.
I wonder how nbsphinx
address this?
from sphinxcontrib-jupyter.
thanks @GavinHuttley. We will incorporate more sphinx
support in this refactor
https://www.sphinx-doc.org/en/master/_modules/sphinx/environment.html
we will see if we can integrate more closely with pathto
information.
from sphinxcontrib-jupyter.
Related Issues (20)
- BUG: Static support files not getting copied for `jupyter` option in jupinx
- BUG: Comments for Book PDF (lecture-source-py) HOT 4
- Docs: Update docs to include information on book pdf
- Update docs with font requirements for lecture pdf book-style compilation
- [FEAT]: Improve ability to have multiple TOC HOT 5
- BUG: Sphinx cache not updating static assets for 'make jupyter' HOT 2
- [Bug] Fragile math during `notebook` to `html` conversion HOT 1
- Treatment of Static Assets HOT 1
- ENH: Revisit reference implementation in translators
- FEAT: Add output option for jupyter directive HOT 1
- BUG: version dependencies like Dask causing errors
- ENH: add next and prev metadata HOT 8
- ENH: Jupyter kernel should be fetched from metadata for execution
- yaml.warnings call raises AttributeError with some versions of YAML
- [BUG] when running jupinx `--files` the index_toc page is not included HOT 1
- [BUG] Title information missing from some lecture navigation buttons
- Consider adding the sphinx-extension GitHub topic HOT 2
- Docutils standard directives like [warning, caution, tip etc.] are not rendered
- doc2path() takes from 2 to 3 positional arguments but 4 were given
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinxcontrib-jupyter.