Skip to content

This repository contains a Sphinx theme used for RAPIDS documentation

License

Notifications You must be signed in to change notification settings

rapidsai/sphinx-theme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 

RAPIDS Sphinx Theme

Warning Work In Progress & Experimental

Using default PyData Theme with customized configuration to standardized RAPIDS documentation navigation.

How to Use

Install the theme:

pip install git+https://github.com/rapidsai/sphinx-theme.git@main

Setup the conf.py file:

html_theme = "rapidsai_sphinx_theme"

How to Develop

  1. Install the theme locally with:
    pip install -e .
  2. Make any necessary changes to the rapidsai_sphinx_theme directory
  3. Build the demo docs locally with:
    sphinx-build -b dirhtml docs _html
  4. Start a development server to view the built docs with:
    python -m http.server -d _html
  5. View the rendered docs @ http://0.0.0.0:8000/

About

This repository contains a Sphinx theme used for RAPIDS documentation

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published