Skip to content

Conversation

@thiswillbeyourgithub
Copy link
Contributor

@thiswillbeyourgithub thiswillbeyourgithub commented Apr 29, 2025

  • whitespace
  • doc: add full doc as a single page for LLMs

As discussed in #754

On my local build, done with cd docs then make clean html, there's the header issue but it might be just me, might be a readthedocs bug and might happen in the website version, and is not that bad anyway IMHO.

edit: put in draft again until I double check the errors when building the docs

Signed-off-by: thiswillbeyourgithub <[email protected]>
@thiswillbeyourgithub thiswillbeyourgithub marked this pull request as ready for review April 29, 2025 13:59
@thiswillbeyourgithub thiswillbeyourgithub marked this pull request as draft April 29, 2025 14:01
@thiswillbeyourgithub
Copy link
Contributor Author

Okay so the current pr is fine. I think it does not interfere at all with the current doc, just adds the new page and reference to it. But apparently the actual good way of doing this would be to use a custom readthedocs builder and that might be quite involved. And would be quite a bit harder for me because I don't have access to readthedocs.

@thiswillbeyourgithub thiswillbeyourgithub marked this pull request as ready for review April 29, 2025 14:16
@amoffat amoffat merged commit 3bf6891 into amoffat:develop Apr 29, 2025
23 checks passed
@thiswillbeyourgithub
Copy link
Contributor Author

Thanks for being open to the idea! I tried clicking on the link in the readme and it 404, has the doc not automatically rebuilt itself?

@amoffat
Copy link
Owner

amoffat commented Apr 29, 2025

The merge broke the docs. It was the only change in the past 2 months, since the docs last built successfully

image

@thiswillbeyourgithub
Copy link
Contributor Author

I noticed that in my wdoc I have the theme in my requirements for the doc: https://github.com/thiswillbeyourgithub/wdoc/blob/main/docs/requirements.txt

Maybe this would help?

Are you sure the build was succesful previously because I thought I saw differences between the local build I have made even before started coding and what I was seeing on the online version.

@thiswillbeyourgithub
Copy link
Contributor Author

Also iirc my local build was using sphinx 8.2.3

@amoffat
Copy link
Owner

amoffat commented Apr 29, 2025

You're right, I misread.. looks like the docs have been broken for awhile. Ay....

@thiswillbeyourgithub
Copy link
Contributor Author

Try maybe with those in the req:
Sphinx 8.2.3
sphinx-rtd-theme 3.0.2

@thiswillbeyourgithub
Copy link
Contributor Author

BTW, though not very used to readthedocs I am willing to help you out of you give me the error messages etc. This is usually something dumb.

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