README.md

RAPIDS Sphinx Theme

Warning Work In Progress & Experimental

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

• RAPIDS nav section based on announcements banner
• Custom colors based on css styling
• Doc versions based on version switcher

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/