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.

Source Distribution

sphinx_julia_theme-0.0.2rc0.tar.gz (6.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page