authentik.core.management.commands.build_source_docs
Build source docs
1"""Build source docs""" 2 3from pathlib import Path 4 5from django.core.management.base import BaseCommand 6from pdoc import pdoc 7from pdoc.render import configure 8 9 10class Command(BaseCommand): 11 """Build source docs""" 12 13 def handle(self, **options): 14 configure( 15 docformat="markdown", 16 mermaid=True, 17 logo="https://goauthentik.io/img/icon_top_brand_colour.svg", 18 ) 19 pdoc( 20 "authentik", 21 output_directory=Path("./source_docs"), 22 )
class
Command(django.core.management.base.BaseCommand):
11class Command(BaseCommand): 12 """Build source docs""" 13 14 def handle(self, **options): 15 configure( 16 docformat="markdown", 17 mermaid=True, 18 logo="https://goauthentik.io/img/icon_top_brand_colour.svg", 19 ) 20 pdoc( 21 "authentik", 22 output_directory=Path("./source_docs"), 23 )
Build source docs
def
handle(self, **options):
14 def handle(self, **options): 15 configure( 16 docformat="markdown", 17 mermaid=True, 18 logo="https://goauthentik.io/img/icon_top_brand_colour.svg", 19 ) 20 pdoc( 21 "authentik", 22 output_directory=Path("./source_docs"), 23 )
The actual logic of the command. Subclasses must implement this method.