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

Building website with custom module docs #384

Open
ImpostorKeanu opened this issue Mar 27, 2024 · 2 comments
Open

Building website with custom module docs #384

ImpostorKeanu opened this issue Mar 27, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@ImpostorKeanu
Copy link

Hi again!

Is there any documentation on how to build the website and have it reflect documentation for custom modules in the "JSON Config Structure"? I've found the moduledoc project, but haven't quite figured how to generate the desired output and marry it with the website content.

If someone is kind enough to give me a few breadcrumbs, maybe I can find the time to document and share the process (if it isn't already).

Thanks again for the phenomenal projects! They're becoming more and more critical to my work with each passing day.

@mholt
Copy link
Member

mholt commented Mar 27, 2024

Good question... there is not. The code that generates the module docs is open source but the website backend is niche (i.e. not generally useful) and not open source because it includes the account database and such.

But, perhaps separating out the module documentation from the rest of the website would be a good endeavor at some point, similar to how you can run godoc locally.

@mholt mholt added the enhancement New feature or request label Mar 27, 2024
@ImpostorKeanu
Copy link
Author

Got it! Thanks for considering the enhancement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants