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

Update to Sphinx 7.2.x #28

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Conversation

wrobell
Copy link
Collaborator

@wrobell wrobell commented Aug 23, 2023

  1. Adapt Hylang domain and documenter code to Sphinx 7.2.x.
  2. Update dependencies to use Sphinx 7.2.x, and RTD theme for 1.2.x (please note that the latter is used for development only).
  3. Use Sphinx logger instead of default Python logger.

The only remaining issues are warning related to parsing of literal blocks, i.e.

hy/docs/api.rst:110: WARNING: Lexing literal_block '(defn name [params] bodyform1 bodyform2…)' as "clojure" resulted in an error at token: '…'. Retrying in relaxed mode.

We use Clojure highlighting for code blocks. I believe we need a new lexer for `clojure-console' (i.e. there is one for Python and Python console). This is out of scope for this pull request, IMHO.

@wrobell
Copy link
Collaborator Author

wrobell commented Sep 27, 2023

@scauligi @Kodiologist Can you please give it a try? I believe this is ready. Unfortunately, this does not solve #24.

@wrobell wrobell changed the title WIP: Start updating to Sphinx 7.2.x Update to Sphinx 7.2.x Sep 27, 2023
@Kodiologist
Copy link
Member

I still don't have the bandwidth to maintain this repository, sorry.

@Kodiologist
Copy link
Member

@wrobell Do you intend to merge this soon? I may be doing some beautification of the Hy manual soon, but I'd probably hold off if you're about to change the expected major Sphinx version, so as not to chase a moving target.

@wrobell
Copy link
Collaborator Author

wrobell commented Nov 16, 2023

I can merge but I am not 100% convinced I am not breaking anything. Any chance 2nd pair of eyes could take a look at documentation output generated by this brach?

@Kodiologist
Copy link
Member

I could look at what Hy's manual looks like with this, if you think that'll help, but there's already a bunch of stuff that's broken with master of sphinxcontrib-hydomain, so it'll be hard to tell newly broken bits from unchanged bits.

@wrobell
Copy link
Collaborator Author

wrobell commented Nov 17, 2023

@Kodiologist I have just fixed this pull request merge conflict due to some changes in master.

Please take a cursory look at the documentation output, and then I will merge.

@Kodiologist
Copy link
Member

I built Hy master's manual with Sphinx 7.2.2 and this PR and it looks pretty much the same. Good job. The only difference I notice is that index.rst shows deeper headings than it used to.

@wrobell
Copy link
Collaborator Author

wrobell commented Nov 17, 2023

It seems directive like autoclass is treated as a section. I will try to fix it.

@wrobell
Copy link
Collaborator Author

wrobell commented Nov 24, 2023

@Kodiologist I hope to look at it this weekend.

@wrobell
Copy link
Collaborator Author

wrobell commented Nov 25, 2023

Also broken:

2023-11-25_17-59-48_385x333

@wrobell
Copy link
Collaborator Author

wrobell commented Nov 25, 2023

I am on the verge of giving up here. Too much copy&paste of not well structured code. I will give it a shot tomorrow again though.

@Kodiologist
Copy link
Member

I'm sorry, yeah. It's a mess. You might have an easier time starting from scratch.

@wrobell
Copy link
Collaborator Author

wrobell commented Dec 1, 2023

@Kodiologist Unfortunately, I am stuck, and I do not have enough energy to dig into this more.

If anyone sees a fix here, please shout.

@Kodiologist
Copy link
Member

That's okay. Maybe someone else will pick up maintenance of this project in the future.

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.

2 participants