Skip to content

Conversation

@gnzng
Copy link
Collaborator

@gnzng gnzng commented Nov 16, 2025

This PR addresses issue #42 , it is not solving it completely, but given instructions on how to build documentation of older versions or git commit hashes.

Copy link
Collaborator

@yoshikisd yoshikisd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making this, I was just wondering about how to build the docs on my machine! The instructions work on my machine.

From the standpoint of consistently organizing the documentation, I feel that it may be more appropriate to include this as a page in the sphinx docs. However, I might be missing something here; is there an advantage to keeping docs/build_custom_docs.md a standalone markdown file?

@gnzng
Copy link
Collaborator Author

gnzng commented Nov 18, 2025

Keeping docs/build_custom_docs.md as a standalone markdown file has a few advantages. It allows for quick access and easy reference by developers without needing to navigate the Sphinx documentation (which is good because it is about building the docs). Markdown files are simpler to read and edit directly in a text editor or on github. The instructions remain accessible even if Sphinx is not setup or the hosting is down.

@yoshikisd
Copy link
Collaborator

That makes sense. In that case, we should keep this as a markdown file. I'll approve this PR and merge it.

@yoshikisd yoshikisd merged commit 4a94ea1 into cdtools-developers:master Nov 18, 2025
9 checks passed
@yoshikisd
Copy link
Collaborator

yoshikisd commented Nov 18, 2025

Hmm, looks like the first attempt to run the checks failed with this error being reported:

remote: Internal Server Error
Error: fatal: unable to access 'https://github.com/cdtools-developers/cdtools/': The requested URL returned error: 500

Not sure if this has any relation to the cloudflare outage that happened today. I tried running the tests again and things completed just fine.

@gnzng
Copy link
Collaborator Author

gnzng commented Nov 18, 2025

github is having some issues: https://downdetector.com/status/github/

@gnzng gnzng deleted the customdocs branch November 18, 2025 22:10
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