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

First try of documentation server, using "mkdocs serve" crashes #108

Open
ph99 opened this issue Jul 11, 2020 · 3 comments
Open

First try of documentation server, using "mkdocs serve" crashes #108

ph99 opened this issue Jul 11, 2020 · 3 comments

Comments

@ph99
Copy link

ph99 commented Jul 11, 2020

I am not particularly swift with Python, but the very, very first thing I tried was bringing up the documentation, and the instructions provided led to an immediate crash.

Followed instructions in README.md from matrix-documentation-master folder, for setting up docs server using Python. It immediately crashed.

I am using Python 3.7.6 - is this the problem? Does it require Python 2?

Here is the output:

(env) (base) paul@krill:~/matrix/matrix-documentation-master$ mkdocs serve
INFO - Building documentation...
Traceback (most recent call last):
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/mkdocs/config/config_options.py", line 366, in walk_docs_dir
raise StopIteration
StopIteration

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

Traceback (most recent call last):
File "/home/paul/matrix/matrix-documentation-master/env/bin/mkdocs", line 8, in
sys.exit(cli())
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/click/core.py", line 829, in call
return self.main(*args, **kwargs)
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/click/core.py", line 782, in main
rv = self.invoke(ctx)
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/click/core.py", line 1259, in invoke
return _process_result(sub_ctx.command.invoke(sub_ctx))
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/click/core.py", line 1066, in invoke
return ctx.invoke(self.callback, **ctx.params)
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/click/core.py", line 610, in invoke
return callback(*args, **kwargs)
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/mkdocs/main.py", line 127, in serve_command
livereload=livereload
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/mkdocs/commands/serve.py", line 110, in serve
config = builder()
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/mkdocs/commands/serve.py", line 101, in builder
theme_dir=theme_dir
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/mkdocs/config/base.py", line 181, in load_config
errors, warnings = cfg.validate()
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/mkdocs/config/base.py", line 105, in validate
post_failed, post_warnings = self._post_validate()
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/mkdocs/config/base.py", line 85, in _post_validate
config_option.post_validation(self, key_name=key)
File "/home/paul/matrix/matrix-documentation-master/env/lib/python3.7/site-packages/mkdocs/config/config_options.py", line 391, in post_validation
for filename in self.walk_docs_dir(config['docs_dir']):
RuntimeError: generator raised StopIteration

@samreenislam
Copy link
Contributor

Hi @ph99, you can access our documentation here if you want to see a rendered version.

@AndresTFG
Copy link

"The URL is no longer available

@matrixplatform
Copy link

matrixplatform commented May 2, 2023 via email

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

No branches or pull requests

4 participants