Skip to main content

Apple Developer Connection Sphinx Theme

https://travis-ci.org/mga-sphinx/sphinx_adc_theme.svg?branch=master

This is a sphinx theme that made for adc.

Installation

Via package

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

$ pip install sphinx_adc_theme

In your conf.py file:

import sphinx_adc_theme

html_theme = "sphinx_adc_theme"

html_theme_path = [sphinx_adc_theme.get_html_theme_path()]

Via git or download

Symlink or subtree the sphinx_adc_theme/sphinx_adc_theme repository into your documentation at docs/_themes/sphinx_adc_theme then add the following two settings to your Sphinx conf.py file:

html_theme = "sphinx_adc_theme"
html_theme_path = ["_themes", ]

Changelog

0.1.4

  • Fix search widget apparence

  • Add version theme in context

0.1.3

  • Fix css validation

0.1.2

  • Fix broken package on pypi

0.1.1

  • Fix Image path in CSS Broken

  • Fix TOC.js nevers load

Contributing or modifying the theme

The sphinx_adc_theme is primarily a sass project that requires a few other sass libraries. I’m using bower to manage these dependencies and sass to build the css. The good news is I have a very nice set of grunt operations that will not only load these dependencies, but watch for changes, rebuild the sphinx demo docs and build a distributable version of the theme. The bad news is this means you’ll need to set up your environment similar to that of a front-end developer (vs. that of a python developer). That means installing node and ruby.

Set up your environment

  1. Install sphinx into a virtual environment.

pip install sphinx
  1. Install sass

gem install sass
  1. Install node, bower and grunt.

// Install node
brew install node

// Install bower and grunt
npm install -g bower grunt-cli

// Now that everything is installed, let's install the theme dependecies.
npm install

Now that our environment is set up, make sure you’re in your virtual environment, go to this repository in your terminal and run grunt:

grunt

This default task will do the following very cool things that make it worth the trouble.

  1. It’ll install and update any bower dependencies.

  2. It’ll run sphinx and build new docs.

  3. It’ll watch for changes to the sass files and build css from the changes.

  4. It’ll rebuild the sphinx docs anytime it notices a change to .rst, .html, .js or .css files.

Before you create an issue

I don’t have a lot of time to maintain this project due to other responsibilities. I know there are a lot of Python engineers out there that can’t code sass / css and are unable to submit pull requests. That said, submitting random style bugs without at least providing sample documentation that replicates your problem is a good way for me to ignore your request. RST unfortunately can spit out a lot of things in a lot of ways. I don’t have time to research your problem for you, but I do have time to fix the actual styling issue if you can replicate the problem for me.

Before you send a Pull Request

When you’re done with your edits, you can run grunt build to clean out the old files and rebuild a new distribution, compressing the css and cleaning out extraneous files. Please do this before you send in a PR.

Metadata

Release files for sphinx-adc-theme 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinx-adc-theme 0.1.4
File Size Uploaded Provenance Actions
sphinx_adc_theme-0.1.4.tar.gz 238.6 kB Without provenance Details for sphinx_adc_theme-0.1.4.tar.gz

Release files / sphinx_adc_theme-0.1.4.tar.gz

Download URL sphinx_adc_theme-0.1.4.tar.gz
Size 238.6 kB
Tags Source
SHA-256 checksum
How to use checksums
4cb73bd64cd00eaa40ade400130f6f8adc5fbb01e13f660bbddaa9554d8b1b72
BLAKE2b-256 checksum
How to use checksums
aa6bc4f34b4a72ef46f699de8b0adea4ee85328965aec9750440cc78d0602cee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for sphinx-adc-theme 0.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page