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

DO NOT MERGE feat: sphinx plugin to get docs outside the main tree #293

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

rgraber
Copy link
Contributor

@rgraber rgraber commented Apr 11, 2023

Description:

This is an example of a Sphinx plugin that can be used to pull in files outside the main docs directory. It does this by creating symlinks from those files into the main docs directory, where they are discoverable by Sphinx. It does mean the paths in index.rst look a little funny because they all point to long paths inside a symlinks folder, but it eliminates the need to make a bunch of files that are just includes of other files. Right now it works by making links to all .rst files in a repo. In theory, in the future it could be configurable to only copy docs the user cares about, and include other file extensions like .md.

If we decide to move forward with this we should make it a proper PyPI package so we can version it.

@rgraber rgraber changed the title feat: sphinx plugin to get docs outside the main tree DO NOT MERGE feat: sphinx plugin to get docs outside the main tree Apr 12, 2023
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.

1 participant