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

ReadTheDocs is broken #431

Closed
LexiconCode opened this issue Mar 30, 2019 · 12 comments
Closed

ReadTheDocs is broken #431

LexiconCode opened this issue Mar 30, 2019 · 12 comments
Labels
Bug Unexpected behavior from existing features. Documentation Issues related to Documentation

Comments

@LexiconCode
Copy link
Member

LexiconCode commented Mar 30, 2019

The ReadTheDocs is using the old repository and has not been updated for dictation-toolbox. @synkarius will need to be contacted for migration.

In addition
https://readthedocs.org/projects/caster/builds/
The last build (3 months ago) failed because it tried to compile wxWidgets.

@LexiconCode LexiconCode added Bug Unexpected behavior from existing features. Documentation Issues related to Documentation labels Mar 30, 2019
@kendonB
Copy link
Collaborator

kendonB commented Jun 3, 2019

Putting this here for reference https://docs.readthedocs.io/en/latest/builds.html

I'm trying to fix this

@kendonB kendonB changed the title ReadTheDocs does not rebuild automatically ReadTheDocs is broken Jun 3, 2019
@kendonB kendonB pinned this issue Jun 3, 2019
@kendonB
Copy link
Collaborator

kendonB commented Jun 3, 2019

The site is broken: https://caster.readthedocs.io/en/latest/

The original issue was that mkdocs was enforcing that the site build directory not be within the site doc/ source directory.

I added a mkdocs.yml file specifying site_dir and docs_dir following https://www.mkdocs.org/user-guide/configuration/.

Then the build succeeded but lots of the pages showed 404 not found. This is still the case now.

I tried adding the pages variable for a single md file and it also didn't work. nav is in the docs but doesn't work; I found an issues which suggested pages would work.

Build info is here:
https://readthedocs.org/projects/caster/builds/

@LexiconCode @synkarius I would like some help to figure out what's preventing the site from building please!

@kendonB
Copy link
Collaborator

kendonB commented Jun 3, 2019

Asked on RTD readthedocs/readthedocs.org#5756

@LexiconCode
Copy link
Member Author

LexiconCode commented Jun 3, 2019

Make an account on RTD and I will add you as a maintainer. Issue is the format of the docs I believe. Due to my academics I can't take the time to find a link atm but I will try later today to give you the information.

Edit: Actually you already have that information. I read your issue in the read the docs. The 'site_dir was inside the docs_dir. ' and that was due to a change in required formatting. I was able to fix a number of errors that wasn't able to figure out that last bit and took a break.

@kendonB
Copy link
Collaborator

kendonB commented Jun 3, 2019

I made the account on RTD so I'm ready for you to make me a maintainer.

@LexiconCode
Copy link
Member Author

@kendonB Done

@kendonB
Copy link
Collaborator

kendonB commented Jun 3, 2019

Made some progress. It builds fine here in my version: https://kendonbcaster.readthedocs.io/en/latest/ but is still failing and I can't see what's different. I asked for help here: readthedocs/readthedocs.org#5761

@kendonB
Copy link
Collaborator

kendonB commented Jun 3, 2019

Fixed now.

@kendonB kendonB closed this as completed Jun 3, 2019
@kendonB kendonB unpinned this issue Jun 3, 2019
@nrmh
Copy link

nrmh commented Jun 18, 2019

ReadMe.md links to https://caster.readthedocs.io/en/latest/README/, which doesn't work. https://caster.readthedocs.io/en/latest/ works fine, though.

@LexiconCode
Copy link
Member Author

ReadMe.md links to caster.readthedocs.io/en/latest/README, which doesn't work. caster.readthedocs.io/en/latest works fine, though.

Thank you. Links Fixed

@nrmh
Copy link

nrmh commented Jun 18, 2019

Just noticed there's a few other links to the docs, all are broken in a different way. s/latest\/caster\/doc/latest/ should fix them.

@LexiconCode
Copy link
Member Author

Good to know I'll see if I can fix it this weekend or earlier if time allows

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Unexpected behavior from existing features. Documentation Issues related to Documentation
Projects
None yet
Development

No branches or pull requests

3 participants