Skip to content

Doc Builds are FAILING!! NEED HELP!! #1165

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

Closed
MikeTheWatchGuy opened this issue Feb 18, 2019 · 6 comments
Closed

Doc Builds are FAILING!! NEED HELP!! #1165

MikeTheWatchGuy opened this issue Feb 18, 2019 · 6 comments
Labels
community input desired Done - Install Dev Build (see docs for how) See https://docs.pysimplegui.com/en/latest/documentation/installing_licensing/upgrading/ help wanted Extra attention is needed URGENT Fire!

Comments

@MikeTheWatchGuy
Copy link
Collaborator

For a number of days the ReadTheDocs builds are failing and I don't know why.

The errors make no sense to me. They don't tell me which of the docs is bad nor why.

The things that have changed over the past weeks have been that I'm using my markdown editor in a way that directly integrated into GitHub. And I have been adding repl.it recipe iframes into the Cookbook. I don't think the readme has any yet.

I don't think it's the iframes because they are up and running in the current working Cookbook located here
http://cookbook.PySimpleGUI.org

Readme is here:
http://www.PySimpleGUI.org

Any help would be greatly appreciated!!!

Here's an example build:
https://readthedocs.org/projects/pysimplegui/builds/8589243/

Build #8589243
latest (1eb3c26878e321867fb1dc28d94353d2087fed3f)
Build failed
git clone --no-single-branch --depth 50 https://github.com/PySimpleGUI/PySimpleGUI .
git checkout --force origin/master
git clean -d -f -f
python3.7 -mvirtualenv --no-site-packages --no-download /home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest
/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/bin/python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/.cache/pip pip
/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/bin/python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/.cache/pip Pygments==2.2.0 setuptools<40 docutils==0.13.1 mock==1.0.1 pillow==2.6.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.5.4 recommonmark==0.4.0 mkdocs==0.17.3
cat mkdocs.yml
python /home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/bin/mkdocs build --clean --site-dir _build/html --config-file /home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/checkouts/latest/mkdocs.yml
INFO    -  Cleaning site directory 
INFO    -  Building documentation to directory: /home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/checkouts/latest/_build/html 
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages/mkdocs/nav.py", line 337, in _follow
    raise StopIteration
StopIteration

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/bin/mkdocs", line 10, in <module>
    sys.exit(cli())
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages/click/core.py", line 764, in __call__
    return self.main(*args, **kwargs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages/click/core.py", line 717, in main
    rv = self.invoke(ctx)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages/click/core.py", line 1137, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages/click/core.py", line 956, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages/mkdocs/__main__.py", line 156, in build_command
    ), dirty=not clean)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages/mkdocs/commands/build.py", line 282, in build
    build_pages(config, dirty=dirty)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages/mkdocs/commands/build.py", line 213, in build_pages
    site_navigation = nav.SiteNavigation(config)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages/mkdocs/nav.py", line 44, in __init__
    config, self.url_context)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages/mkdocs/nav.py", line 392, in _generate_site_navigation
    config_line, url_context, config):
RuntimeError: generator raised StopIteration

@dddomodossola
Copy link

Hello @MikeTheWatchGuy , I'm pretty sure the error you are getting is related to an mkdocs's issue mkdocs/mkdocs#1518
It seems that an mkdocs update solves the problem Version 0.17.5

@MikeTheWatchGuy
Copy link
Collaborator Author

MikeTheWatchGuy commented Mar 4, 2019

I continue to get errors. Still can't get my readme to get built correctly by readthedocs. My Cookbook does fine.

How can I solve this problem? I'm not running mkdocs. I think it's readthedocs that does that.

I do see in the build notes from readthedocs:
Requirement already up-to-date: mkdocs==0.17.3 in /home/docs/checkouts/readthedocs.org/user_builds/pysimplegui/envs/latest/lib/python3.7/site-packages (0.17.3)
Now it looks like I may need to find a way to change that version number

@MikeTheWatchGuy
Copy link
Collaborator Author

HHHHEEELLLLPPP!!!!

I'm now going backwards.

It seems that readthedocs completely melts down now if you are using markdown documentation. If using sphinx, evidently no problems.

I'm REALLY disappointed in the readthedocs people for upgrading to Python 3.7, introducing errors as a result that have left my documentation in shambles.

It's not FAIR!

Damn, I spend enough time working on these docs and now it's been 2 months since I've been able to upload new docs that I've made.

I'm going to have to hire someone to fix this.

Does anyone here want to make some money fixing this shit?

If not, I guess I'm off to fiverr for help.

@dddomodossola
Copy link

@MikeTheWatchGuy I would really help you in this but unfortunately I'm really busy for work and family. However I have an idea. Would it be possible to build the docs locally and upload them directly into the project repository? removing readthedocs I mean.

@MikeTheWatchGuy
Copy link
Collaborator Author

Oh, I understand your situation Davide..... don't worry about helping me. You've done enough.

I filed a bug with the readthedocs people, but the response didn't help me much.

You can update to a new version of mkdocs with a requirements file or downgrading the python version. You can do both things using a configuration file https://docs.readthedocs.io/en/stable/config-file/v2.html

Closing as duplicated of #5332

I've spent an hour trying to create and modify this yml file thing.

What I've gone back and asked for is a file to be provided that fixes THEIR BUG.

What's terrible at the moment is that a classroom of kids JUST TODAY started using PySimpleGUI in their class, and now ALL of the PySimpleGUI docs are dead and gone. http://www.PySimpleGUI.org is no more. All because of a bug in the readthedocs code. It's kinda pissing me off to be honest.

I did build and upload a version of the docs using another tool that converted my markdown docs into something that looks like readthedocs. The instructions for that tool was that I could "host" the html anywhere, including on GitHub.

So, I created and uploaded my docs here:
https://github.com/PySimpleGUI/PySimpleGUI/tree/master/docs_html

I don't know how to get those files "hosted" somehow so that users can visit there and they'll see the files as a website.

@MikeTheWatchGuy
Copy link
Collaborator Author

Once I connected up with @stsewd the problem got resolved!

He really went out of his way to help step me through this process. You can read about my ordeal here

Now I know a bit better about how the PySimpleGUI users feel when I finally address one of their problems. I apologize to everyone that has been waiting on fixes. I've been focused 100% on getting these docs back!

@MikeTheWatchGuy MikeTheWatchGuy added the Done - Install Dev Build (see docs for how) See https://docs.pysimplegui.com/en/latest/documentation/installing_licensing/upgrading/ label Mar 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community input desired Done - Install Dev Build (see docs for how) See https://docs.pysimplegui.com/en/latest/documentation/installing_licensing/upgrading/ help wanted Extra attention is needed URGENT Fire!
Projects
None yet
Development

No branches or pull requests

2 participants