search

ladybug-tools / ladybug-comfort

🐞 :tired_face: :smile: :sweat: Ladybug extension for thermal comfort
https://www.ladybug.tools/ladybug-comfort/docs/
GNU Affero General Public License v3.0
13 stars 20 forks source link

docs(sphinx-conf): Fix CLI documentation process #287

Closed santiagogaray closed 3 years ago

santiagogaray commented 3 years ago

Hi @chriswmackey,

I found a unique situation in this repo that I would like to make sure I handle it correctly. The ladybug_comfort/cli/init.py file has a comfort group without any commands added. 

# command group for all comfort extension commands.
@click.group(help='ladybug comfort commands.')
@click.version_option()
def comfort():
    pass

Currently I ignore this scenarios and don't' create a main section without commands, but I realize now that we have the @click.version_option decorator that will probably render something like the top portion of the honeybee-energy cli doc... Do we want to have this standalone option in the main section? My guess is yes but I wanted to double check!

image

santiagogaray commented 3 years ago

Sounds good @chriswmackey. Feel free to merge this one at it is. Will add support for the version option in a future version.

github-actions[bot] commented 3 years ago

:tada: This PR is included in version 0.12.11 :tada:

The release is available on:

Your semantic-release bot :package::rocket: