Skip to content

chore: make Sphinx cookbook extension pip-installable#2447

Merged
lidavidm merged 5 commits intoapache:mainfrom
lidavidm:gh-2432
Jan 15, 2025
Merged

chore: make Sphinx cookbook extension pip-installable#2447
lidavidm merged 5 commits intoapache:mainfrom
lidavidm:gh-2432

Conversation

@lidavidm
Copy link
Copy Markdown
Member

Fixes #2432.

@lidavidm
Copy link
Copy Markdown
Member Author

Both of these should work:

pip install --dry-run 'git+https://github.com/lidavidm/arrow-adbc@gh-2432#subdirectory=docs/source/ext/illiterate_sphinx'
pip install --dry-run 'https://github.com/lidavidm/arrow-adbc/archive/gh-2432.zip#subdirectory=docs/source/ext/illiterate_sphinx'

The latter seems a bit faster.

@lidavidm lidavidm requested a review from paleolimbot January 14, 2025 02:25
@lidavidm
Copy link
Copy Markdown
Member Author

After this, the main improvements I'd like to make are:

  • Make sure Java/jshell works, too
  • Work out some way to support showing expected stdout/stderr in the recipe (vs the current approach of using assertions). (The test harness would probably just validate the stdout/stderr as a whole, instead of trying to run the code line by line, but I think that's OK.)

@lidavidm
Copy link
Copy Markdown
Member Author

I'm also reconsidering the name here, if anyone has better suggestions...

@paleolimbot
Copy link
Copy Markdown
Member

Install worked great for me!

@lidavidm
Copy link
Copy Markdown
Member Author

Thanks for checking! I think I'll rename the package just out of caution then merge it.

@lidavidm lidavidm merged commit 74a09a3 into apache:main Jan 15, 2025
@lidavidm lidavidm deleted the gh-2432 branch January 15, 2025 23:48
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.

docs: factor out Sphinx utilties

2 participants