Git Product home page Git Product logo

jupyter-sphinx-theme's Introduction

jupyter-sphinx-theme

A Jupyter Sphinx theme for narrative documentation.

Installation

Install the package using PIP:

pip install jupyter_sphinx_theme

Edit the "conf.py" configuration file to point to the jupyter theme:

# At the top.
from jupyter_sphinx_theme import *
init_theme()

# ...

# Comment out the `html_theme =` line

jupyter-sphinx-theme's People

Contributors

blink1073 avatar carreau avatar charnpreetsingh avatar cvrebert avatar danack avatar daveisfera avatar fjfeijoo avatar grncdr avatar inducer avatar jdfreder avatar kaycebasques avatar kosiakk avatar masklinn avatar michilu avatar newgene avatar rgbkrk avatar russell avatar ryan-roemer avatar sccolbert avatar shiumachi avatar torbjoernk avatar vitaut avatar willingc avatar zyga avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

jupyter-sphinx-theme's Issues

Missing jupyter.css

I might just be missing an installation step for css. Here's the traceback:

screen shot 2016-03-23 at 9 40 57 pm

Heading sizes in demo are incorrect

The headings applied in the demo do not correspond to headings they claim to be.

<div class="section" id="Headings">
<h2>Headings<a class="headerlink" href="#Headings" title="Permalink to this headline">¶</a></h2>
<p>This is a first level heading (<code class="docutils literal"><span class="pre">h1</span></code>).</p>
<div class="section" id="Sub-Heading">
<h3>Sub-Heading<a class="headerlink" href="#Sub-Heading" title="Permalink to this headline">¶</a></h3>
<p>This is a second level heading (<code class="docutils literal"><span class="pre">h2</span></code>).</p>
<div class="section" id="Sub-Sub-Heading">
<h4>Sub-Sub-Heading<a class="headerlink" href="#Sub-Sub-Heading" title="Permalink to this headline">¶</a></h4>
<p>This is a third level heading (<code class="docutils literal"><span class="pre">h3</span></code>).</p>
</div>

No license file

There is no LICENSE, LICENSE.md, LICENSE.rst, or LICENSE.txt. There is a BOOTSTRAP_THEME_LICENSE.txt, but it's not really clear to what this applies, since the name implies that it's only some smaller part of the repo.

setup.py states MIT, so it would be good to include a license file that says so.

Deprecate the jupyter theme altogether?

(Opening this to keep track of the discussions on the subject.) Here is an opinionated take on the matter:

I think that we should not have a custom sphinx theme on RTD.

  • The RTD team does a great job with their them that works on a large variety of browsers and mobile devices.
  • They dedicate more bandwidth to this problem than the jupyter team will ever do. If one of us wants to work on this subject, it might be better to help them than trying to do our own thing.
  • IMO, having a uniform style on all RTD-hosted docs is a nice feature of their web site and we would be better citizens if we adopted the main theme.
  • The only case where we would need to customize things is when we need to add custom javascript such as inline widget rendering, but in this case I would be in favor of using their theme and only adding static resources for the inline widget renderer.

Now, for the Jupyter website, if we were to host our own version of the docs, we could do our own theme. But even then, the best solution is likely to use the most advanced theme out there that is the one of RTD plus some color changes.

rename repo ?

Should we rename the repo to jupyter-sphinx-theme for consistency ?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.