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

images from the release history not captured #120

Open
jgunstone opened this issue Jan 26, 2024 · 5 comments
Open

images from the release history not captured #120

jgunstone opened this issue Jan 26, 2024 · 5 comments

Comments

@jgunstone
Copy link

jgunstone commented Jan 26, 2024

for example:

image

is this a known limitation or is there any chance that this could be supported?

cheers

@ewjoachim
Copy link
Owner

It's not a know limitation, would you like to investigate ?

@ewjoachim
Copy link
Owner

I think it might be solved by the same fix that will handle #122 . Once we have proper docutils nodes, I believe we'll have better support for specific tags

@sahiljhawar
Copy link

sahiljhawar commented Mar 8, 2024

@jgunstone can you provide the repo for which you built the docs since I do not have any repo with images in the changelog. I may want to give it a try.

@ewjoachim
Copy link
Owner

ewjoachim commented Mar 8, 2024

It shouldn't be too hard to create one.
I suggest the following script, it requires gh

Here's the setup script

cd <wherever you want to create the repo>
mkdir sphinx-github-changelog-devenv
cd mkdir sphinx-github-changelog-devenv
git init
gh repo create --public --source .

echo "foo" > foo
git add .
git commit -m foo
git push -u origin main
gh release create v1 --title "v1" --notes "a _b_ *c*"

echo "bar" > foo
git add .
git commit -m bar
git push -u origin main
gh release create v2 --title "v2" --notes "[d](https://example.com)"

python3 -m venv .venv
source .venv/bin/activate
pip install sphinx sphinx-github-changelog
# or
pip install sphinx ../path/to/checkout/of/sphinx-github-changelog
sphinx-quickstart docs \
    --sep --project sphinx-github-changelog-devenv \
    --author myself --release main --language en \
    --extensions sphinx_github_changelog

echo  >> docs/source/index.rst
echo  >> docs/source/index.rst
echo ".. changelog::" >> docs/source/index.rst
echo "    :github: $(gh repo view --json url --jq '.url')/releases" >> docs/source/index.rst

export SPHINX_GITHUB_CHANGELOG_TOKEN=$(gh auth token)
make -C docs SPHINXOPTS=-EW clean html

python3 -m webbrowser ./docs/build/html/index.html

@ewjoachim
Copy link
Owner

(Woops, got the issues confused, my initial message above included the steps needed to reproduce #122 but it's not needed in this issue. I've removed the said steps.)

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

No branches or pull requests

3 participants