Skip to content

Added substitutions extension#53

Merged
dgarcia360 merged 7 commits intoscylladb:masterfrom
dgarcia360:substitutions
Oct 20, 2020
Merged

Added substitutions extension#53
dgarcia360 merged 7 commits intoscylladb:masterfrom
dgarcia360:substitutions

Conversation

@dgarcia360
Copy link
Copy Markdown
Collaborator

Closes #35

To make it work on the main docs, I'll need to publish the theme to PyPi and submit an additional PR to scylladb/scylla-docs updating the version.

@@ -0,0 +1,101 @@
"""
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Any reason not to install this with PyPi like we do for all other extension?

Copy link
Copy Markdown
Collaborator Author

@dgarcia360 dgarcia360 Aug 29, 2020

Choose a reason for hiding this comment

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

The original extension reads all the extensions listed in the file conf.py and raises a warning if sphinx-prompts does not exist (lines 25-30).

However, the theme loads dependencies dynamically to have to list them in every ScyllaDB documentation project. Due to how the extension is coded, installing the original extension as is would cause to install the dependency sphinx-prompts in every documentation project individually.

This does not look right since ScyllaDB docs do not use sphinx-prompts at all to display code chunks, but code-blocks. Instead, I have opted to remove the prompts directive support by adapting the extension code.

@dgarcia360 dgarcia360 requested a review from tzach September 16, 2020 10:15
@lauranovich
Copy link
Copy Markdown
Contributor

@dgarcia360 there are conflicts which need resolution here

@dgarcia360
Copy link
Copy Markdown
Collaborator Author

@lauranovich Fixed the merge conflicts.

@lauranovich
Copy link
Copy Markdown
Contributor

conflicts need to be resolved here ... @dgarcia360 @tzach ?

@dgarcia360
Copy link
Copy Markdown
Collaborator Author

@lauranovich Applied the latest changes to this branch.

@dgarcia360 dgarcia360 merged commit c8753ba into scylladb:master Oct 20, 2020
@dgarcia360 dgarcia360 deleted the substitutions branch October 20, 2020 12:57
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.

Install sphinx-substitution-extensions

3 participants