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

New glossary links styling #245

Merged
merged 1 commit into from
Mar 18, 2021
Merged

New glossary links styling #245

merged 1 commit into from
Mar 18, 2021

Conversation

nomicode
Copy link
Contributor

@nomicode nomicode commented Mar 17, 2021

this PR adds one commitc. the commit messages contain a description of the change

@nomicode nomicode requested review from msbt and a team March 17, 2021 13:56
@nomicode
Copy link
Contributor Author

nomicode commented Mar 17, 2021

thx @amotl!

I will wait for @msbt to comment on my CSS changes. I am no expert! haha

@msbt
Copy link
Collaborator

msbt commented Mar 17, 2021

@norosa the build doesn't work anymore, not sure if it's on my end, gonna check tomorrow:

ubuntu@dev:~/Documents/GitHub/crate-docs-theme/docs$ make SPHINX_OPTS='-W -n --host 0.0.0.0' dev
make[1]: Entering directory '/home/ubuntu/Documents/GitHub/crate-docs-theme/docs'
make[1]: Leaving directory '/home/ubuntu/Documents/GitHub/crate-docs-theme/docs'
make[1]: Entering directory '/home/ubuntu/Documents/GitHub/crate-docs-theme/docs'
Creating a Python virtual environment...
Traceback (most recent call last):
  File "<string>", line 1, in <module>
AssertionError
ERROR: Python>=3.7 is required.
.crate-docs/src/rules.mk:134: recipe for target '.crate-docs/.venv/bin/activate' failed
make[1]: *** [.crate-docs/.venv/bin/activate] Error 1
make[1]: Leaving directory '/home/ubuntu/Documents/GitHub/crate-docs-theme/docs'
Makefile:152: recipe for target 'dev' failed
make: *** [dev] Error 2

python --version gives Python 3.7.9

@nomicode
Copy link
Contributor Author

@msbt can you run make reset and then try again?

@msbt
Copy link
Collaborator

msbt commented Mar 17, 2021

@norosa I always do that before make dev, same issue, even updated python to 3.7.10 and rebooted the machine.

@nomicode
Copy link
Contributor Author

@amotl you added this check. do you know what's up here? :)

@amotl
Copy link
Member

amotl commented Mar 18, 2021

do you know what's up here? :)

Everything should work again after upgrading to crate-docs 1.0.0. Please integrate #246 and then #245 afterwards. After that, you might also want to bring in #247.

Thanks already!

@nomicode nomicode changed the title Build upgrade plus new glossary links styling New glossary links styling Mar 18, 2021
@nomicode
Copy link
Contributor Author

@amotl I removed my build commit. I also removed the links in docs/index.rst (that you recently modified) because neither of those links are actually used in the doc

@amotl
Copy link
Member

amotl commented Mar 18, 2021

Hi Naomi,

[1] croaks on:

/home/runner/work/crate-docs-theme/crate-docs-theme/docs/index.rst:23:Unknown target name: "report an issue".

[2] also mentions that as warnings, but apparently doesn't croak. However, we can see it is still running on Sphinx 1.8.5.

Apart from that, from recognizing the difference between the linkchecker output between [1] and [2], I wonder if we already use the --keep-going flag to sphinx-build here or there?

With kind regards,
Andreas.

[1] https://github.com/crate/crate-docs-theme/pull/245/checks?check_run_id=2139729762#step:4:136
[2] https://readthedocs.org/projects/crate-docs-theme/builds/13279104/

@amotl
Copy link
Member

amotl commented Mar 18, 2021

I wonder if we already use the --keep-going flag to sphinx-build here or there?

crate/crate-docs#66 brings it back to crate-docs. Can you issue a 1.0.1 fixup release?

@nomicode
Copy link
Contributor Author

@amotl can I ask you to fix the index.rst error? for some reason, I cannot rebase against origin/master in my local checkout. I think I borked my local git refs somehow as I get multiple warning: refname 'origin/master' is ambiguous messages

I will try to fix my git but it's probably faster for you to just add the link ref back in yourself and squash

also perhaps you can do the crate-docs 1.0.1 release? I don't trust my local checkouts as I seem to have borked the crate-docs history too (leading to the two recent master history issues)

I will just wipe my clones and start afresh

@msbt
Copy link
Collaborator

msbt commented Mar 18, 2021

Ok this is somewhat embarassing, I had python3 installed two times and one of those was 3.6.9, so the make script got stuck there. Either way, thanks to @amotl I've an updated Ubuntu 20 now which has a default python 2 and 3 installed and the master build works. The PR however doesn't, only when I remove the links in index.rst (`report an issue`_ and `developer guide`_ because they have no target).

Other than that, glossary looks fine @norosa!

@nomicode
Copy link
Contributor Author

@msbt thanks! yeah for some reason, those links were added on master but I haven't been able to pick up that change so my removal breaks things

I'll try again now to fix this

@nomicode
Copy link
Contributor Author

fixed it :)

@nomicode nomicode added the ready-to-merge Let Mergify merge the PR once approved and checks pass label Mar 18, 2021
@mergify mergify bot merged commit 21d0767 into master Mar 18, 2021
@mergify mergify bot deleted the nomi/build-upgrade branch March 18, 2021 17:03
@amotl
Copy link
Member

amotl commented Mar 18, 2021

Yay, merged. Sorry, just came back to the keyboard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-to-merge Let Mergify merge the PR once approved and checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants