[docs-beta] sphinx build attempt #2 #23787
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview for dagster-docs ready! Preview available at https://dagster-docs-hhwab2gf4-elementl.vercel.app Direct link to changed pages: |
This adds some base linting styles using Vale. These are a collection of both suggestions and errors that will raise when run against our new docs site.
This is a single commit for the work done on the new docs revamp project. In order to keep the commit history clean, changes from the docs/revamp branch were squashed into a single commit.
This refactors our existing Sphix builder, in prep for the upcoming docs revamp. The Makefile and requirements are simplified and a bug in the Sphinx extension is fixed.
This removes unused Sphinx layout files and creates a basic Sphinx html template and layout. While this layout will not be used in the final version of the docs project, it allows for easily building Sphinx docs locally as proof-of-concept of the future docs work.
This updates the sphinx conf.py file so that Dagster packages no longer need to be manually added to the paths. It also adds a few helper extensions, mainly `sphinx_copybutton` to allow you to copy a code snippet when output is rendered as html.
cmpadden
force-pushed
the
docs/revamp-shinx-2
branch
from
41131bf to
289d8c1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary & Motivation
How I Tested These Changes
Notes:
SPHINXOPTS="-W"which blocks on warnings [reference]