Skip to main content

Julia theme for Sphinx based on ReadTheDocs theme.

Project description

screen_mobile.png

Installation

Download the package or add it to your requirements.txt file:

$ pip install sphinx_julia_theme

In your conf.py file:

import sphinx_julia_theme

html_theme = "sphinx_julia_theme"

html_theme_path = [sphinx_julia_theme.get_html_theme_path()]

Configuration

You can configure different parts of the theme.

Project-wide configuration

The theme’s project-wide options are defined in the sphinx_julia_theme/theme.conf file of this repository, and can be defined in your project’s conf.py via html_theme_options. For example:

html_theme_options = {
    'collapse_navigation': False,
    'display_version': False,
    'navigation_depth': 3,
}

Page-level configuration

Pages support metadata that changes how the theme renders. You can currently add the following:

  • :github_url: This will force the “Edit on GitHub” to the configured URL
  • :bitbucket_url: This will force the “Edit on Bitbucket” to the configured URL
  • :gitlab_url: This will force the “Edit on GitLab” to the configured URL

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx_julia_theme, version 0.0.2rc0
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_julia_theme-0.0.2rc0.tar.gz (6.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page