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

MKDOCS not producing output for mkdocstrings #107

Closed
vkuehn opened this issue Feb 25, 2024 · 0 comments · Fixed by #108
Closed

MKDOCS not producing output for mkdocstrings #107

vkuehn opened this issue Feb 25, 2024 · 0 comments · Fixed by #108
Assignees
Labels
bug Something isn't working

Comments

@vkuehn
Copy link

vkuehn commented Feb 25, 2024

Describe the bug

the -mkdocstrings configuration is not producting docstrings for code

To Reproduce

Steps to reproduce the behavior:

  1. just run the cookicutter for an empty project with no uploads set
  2. add some docstring to basic code in a code file / test file
  3. run make docs
  4. look for the modules output

thanks using not sphinx here !
not sure if that is an issue with the cookie but if mkdocstringsworks for you what configuration is needed ?

Expected behavior

some mkdocs are produced andserved for the docstrings

System [please complete the following information]:

  • OS: e.g. [Ubuntu 22.04]
  • Language Version: [e.g. Python 3.10]
  • Virtual environment: [mkdocs 1.5.3, poetry 1.8.0]

just started using the cookie and even first time cookicutter user

@vkuehn vkuehn added the bug Something isn't working label Feb 25, 2024
@fpgmaas fpgmaas linked a pull request Mar 14, 2024 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants