search

itdependsnetworks / mkdocs-python-classy

A mkdocs plugin to show "classy" views
https://mkdocs-python-classy.readthedocs.io/
Other
1 stars 0 forks source link

Can you provide an example configuration? #5

Open mmulich opened 2 months ago

mmulich commented 2 months ago

Environment

Expected Behavior

Firstly, I'm new to mkdocs, so I'm sure there are some obvious howto stuff I'm missing. This is my first usage of mkdocs and your plugin.

I would have expected to be able to follow an example provided in your documentation. I had to go splunking into your code to see the plugin's configuration keys. Providing docs around the configuration of your plugin would be useful for adoption of your plugin.

I can get the mkdocs serve to run with the following. But clearly this isn't useful because it doesn't do anything except initialize the plugin. 

plugins:
  - mkdocs-python-classy:
      classy_libraries: []

At this point I'm code diving and need to lookup details about mkdocs like how to write a plugin in order to understand your plugin. I'd like to use your plugin based on the screenshots provided and prior usage of https://ccbv.co.uk/. But now more time is required to dive into this. You could definitely help folks that would like to use your plugin by providing an example. Thanks!

Also, pygments appears to be an unmentioned dependency.

mmulich commented 2 months ago

If you provide me with a somewhat working example, I can try to update the docs and submit a PR for ya.

mmulich commented 2 months ago

I did a search within the rendered documentation for 'meta' and found https://mkdocs-python-classy.readthedocs.io/en/latest/user/lib_mkdocs_configurations/. This piece of documentation is not linked in any of the top-level pages.

itdependsnetworks commented 2 months ago

If you provide me with a somewhat working example, I can try to update the docs and submit a PR for ya.

https://github.com/networktocode/netutils/blob/develop/mkdocs.yml#L86-L91

I did a search within the rendered documentation for 'meta' and found https://mkdocs-python-classy.readthedocs.io/en/latest/user/lib_mkdocs_configurations/. This piece of documentation is not linked in any of the top-level pages.

ok, will put in a PR to fix that.

itdependsnetworks commented 2 months ago

Updated navigation: https://mkdocs-python-classy.readthedocs.io/en/latest/user/lib_mkdocs_configurations/