search

Infoblox-PS / ibx-sdk

Basic Tools and Functions used by other Integrations.
Apache License 2.0
4 stars 0 forks source link

Refactor Documentation #29

Closed yeti9990 closed 11 months ago

yeti9990 commented 11 months ago

The package structure for mkdocs documentation should be as follows:

The Classes are currently in the User-Guide. This should be more of a HOWTO or cookbook of using the package. We don't really want to write a all that in our docstrings - some yes, but the User Guide should be mostly static MD pages. So, we should move the classes/module docs out of the User Guide and come up with a stepwise guide to using this kit.

yeti9990 commented 11 months ago

@mjsmithkc with all the work you did this morning on the reorg of the docs - i think this is now closed right?

mjsmithkc commented 11 months ago

Please close

From: Patrick PIper - IB @.> Date: Friday, December 8, 2023 at 3:45 PM To: Infoblox-PS/ibx-tools @.> Cc: Michael Smith @.>, Mention @.> Subject: Re: [Infoblox-PS/ibx-tools] Refactor Documentation (Issue #29) @mjsmithkc with all the work you did this morning on the reorg of the docs - i think this is now closed right? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned. Message ZjQcmQRYFpfptBannerStart This Message Is From an External Sender This message came from outside your organization.

ZjQcmQRYFpfptBannerEnd

@mjsmithkchttps://urldefense.com/v3/__https:/github.com/mjsmithkc__;!!JYsgTRAg6ZQ!I4c-rj8ucX-e2EGk6DEz9aQ8_-8u-jZI4RnyQuSOoZBps38n8p8QFkwbn83VsSczH_imX0HRGpljMNYEtsnQCIVEpQ$ with all the work you did this morning on the reorg of the docs - i think this is now closed right?

— Reply to this email directly, view it on GitHubhttps://urldefense.com/v3/__https:/github.com/Infoblox-PS/ibx-tools/issues/29*issuecomment-1847881701__;Iw!!JYsgTRAg6ZQ!I4c-rj8ucX-e2EGk6DEz9aQ8_-8u-jZI4RnyQuSOoZBps38n8p8QFkwbn83VsSczH_imX0HRGpljMNYEtsmMkmWkjw$, or unsubscribehttps://urldefense.com/v3/__https:/github.com/notifications/unsubscribe-auth/ACVSVIC4XTJXZWZXDRJO5K3YIODBDAVCNFSM6AAAAABAM2635SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNBXHA4DCNZQGE__;!!JYsgTRAg6ZQ!I4c-rj8ucX-e2EGk6DEz9aQ8_-8u-jZI4RnyQuSOoZBps38n8p8QFkwbn83VsSczH_imX0HRGpljMNYEtslTwrOt5Q$. You are receiving this because you were mentioned.Message ID: @.***>