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

Instructions only generate API for "mkapi"? #22

Closed
tony opened this issue Aug 2, 2020 · 1 comment
Closed

Instructions only generate API for "mkapi"? #22

tony opened this issue Aug 2, 2020 · 1 comment

Comments

@tony
Copy link
Contributor

tony commented Aug 2, 2020

(Edit: Found a bug, will make a PR)

I couldn't find instructions on how set the package (sorry if I'm missing something). I am only able to generate mkdocs itself.

Name: mkapi
Version: 1.0.12
Summary: An Auto API Documentation tool.
Home-page: https://mkapi.daizutabi.net
Author: daizutabi
Author-email: [email protected]
License: MIT
Location: /home/t/work/python/libvcs/.venv/lib/python3.7/site-packages
Requires: jinja2, markdown
Required-by:
libvcs on  new-docs [✘!] ❯ python -V
Python 3.7.7
libvcs on  new-docs [✘!] ❯ pip show mkdocs
Name: mkdocs
Version: 1.1.2
Summary: Project documentation with Markdown.
Home-page: https://www.mkdocs.org
Author: Tom Christie
Author-email: [email protected]
License: BSD
Location: /home/t/work/python/libvcs/.venv/lib/python3.7/site-packages
Requires: PyYAML, Jinja2, tornado, livereload, lunr, click, Markdown
Required-by: mkdocstrings, mkdocs-material

image

mkdocs.yml:

# mkdocs.yml
site_name: libvcs
site_url: https://libvcs.git-pull.com
repo_url: https://github.com/vcs-python/libvcs
repo_name: 'GitHub'
theme:
  name: "material"
  custom_dir: .
  logo: assets/images/libvcs.svg
  favicon: assets/images/favicon.ico

plugins:
  - search
  - mkapi

nav:
  - index.md
  - API: mkapi/api/mkapi
  #   - API: mkapi/api/libvcs will crash
tony added a commit to tony/mkapi that referenced this issue Aug 2, 2020
Fixes issue discovered accidentally in daizutabi#22 where a numpy
docstring attribute without a description leads to IndexError
of an empty line.
@tony
Copy link
Contributor Author

tony commented Aug 2, 2020

Closing. After #23 I am getting my module to generate properly

@tony tony closed this as completed Aug 2, 2020
tony added a commit to vcs-python/libvcs that referenced this issue Aug 2, 2020
Having a handing numpy attribute without a description at the end
of a docstring leads to an empty line.

See also:
- daizutabi/mkapi#22
- daizutabi/mkapi#23
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

1 participant