daizutabi/mkapi

mkapi fails for me after fresh install

Closed this issue · 1 comments

Steps to pre-produce

  • mkdir test-mkapi
  • cd test-mkapi
  • python3.7 -m venv .env
  • source .env/bin/activate
  • pip install mkdocs
  • pip install mkapi
  • mkdocs new .

edit mkdocs.yml to look like

site_name: My Docs
plugins:
  - search
  - mkapi

Then issue mkdocs serve

Expected behavior:

Mkdocs will serve the default mkdocs website on 127.0.0.1:8000

Actual behavior

  <snip>
  File "/home/daniel/Repositories/binance-asyncio/.env/lib/python3.9/site-packages/mkapi/plugins/api.py", line 19, in create_nav
    for page in nav:
TypeError: 'NoneType' object is not iterable

Note

If i change mkdocs.yml to

site_name: My Docs
plugins:
  - search

all is good. generates, Mkdocs will serve the default mkdocs website on 127.0.0.1:8000 as expected

Additional information, poking around with it a bit showed that if I change my mkdocs.yml file to

site_name: My Docs
plugins:
  - search
  - mkapi
nav:
  - index.md

everything works.