Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dask config extension to sphinx theme #64

Merged
merged 1 commit into from
Feb 24, 2022

Conversation

quasiben
Copy link
Member

closes #63

Adds the config extension from dask/dask#6069 to the dask theme. Note, this will require a dask-sphinx-theme release before we are able to use in dask/dask or any dask project

cc @jacobtomlinson

Copy link
Member

@jrbourbeau jrbourbeau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks @quasiben! I like the idea of making it easier for other projects to use the config extension.

Do you know if it's possible for other projects, which aren't using dask-sphinx-theme as their documentation theme, but do integrate with Dask's config system to still take advantage of this extension? My guess is "yes", but wanted to double check with you

Also, could you add a snippet to the README which documents how this extension should be used? For example, over in dask/dask we have things like

Dask
~~~~

.. dask-config-block::
    :location: dask
    :config: https://raw.githubusercontent.com/dask/dask/main/dask/dask.yaml
    :schema: https://raw.githubusercontent.com/dask/dask/main/dask/dask-schema.yaml


Distributed Client
~~~~~~~~~~~~~~~~~~

.. dask-config-block::
    :location: distributed.client
    :config: https://raw.githubusercontent.com/dask/distributed/main/distributed/distributed.yaml
    :schema: https://raw.githubusercontent.com/dask/distributed/main/distributed/distributed-schema.yaml

@jacobtomlinson
Copy link
Member

Thanks for handling this @quasiben.

@jrbourbeau this plugin is orthogonal to the theme itself, it just adds a new directive. You should be able to use this extension independently of which theme you configure. It just felt like this was a natural place for Dask Sphinx things to live.

@jacobtomlinson jacobtomlinson merged commit bffea66 into dask:main Feb 24, 2022
@jacobtomlinson
Copy link
Member

This is now in 2.0.3 which is on PyPI and should be on Conda Forge later.

@jrbourbeau
Copy link
Member

You should be able to use this extension independently of which theme you configure

Great, that's what I thoughts -- just wanted to double check. Can we add documentation on this new directive?

@jacobtomlinson
Copy link
Member

I've raised #66 to track this

@quasiben quasiben deleted the add-dask-conf-ext branch February 28, 2022 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add dask-config-sphinx extension to Dask-sphinx-theme
3 participants