Updated mkdocs export to keep desc consistent

JordanRL · Jul 6, 2021 · f02f314 · f02f314
1 parent 8a2241b
commit f02f314
Show file tree

Hide file tree

Showing 9 changed files with 166 additions and 335 deletions.
diff --git a/doc-templates/roster-templates-mkdocs/css/roster-style.css b/doc-templates/roster-templates-mkdocs/css/roster-style.css
diff --git a/doc-templates/roster-templates-mkdocs/snippets/classInterface.md b/doc-templates/roster-templates-mkdocs/snippets/classInterface.md
@@ -1,4 +1,4 @@
-!!! signature trait "{$interfaceName}"
+!!! signature interface "{$interfaceName}"
     namespace
     :   {$interfaceNamespace}
 

diff --git a/doc-templates/roster-templates-mkdocs/snippets/method.md b/doc-templates/roster-templates-mkdocs/snippets/method.md
@@ -8,7 +8,11 @@
     description
     :   {$methodReturnDesc}{$hasDesc}
 
-{$methodDescription}{hasDesc$}{$hasExample}
+    **{$className}{$connector}{$methodName} Description**
+
+    {$methodDescription}{hasDesc$}{$hasExample}
 
 !!! example "Example"
     {$methodExample}{hasExample$}
+
+---
diff --git a/doc-templates/roster-templates-mkdocs/snippets/staticMethod.md b/doc-templates/roster-templates-mkdocs/snippets/staticMethod.md
@@ -8,7 +8,11 @@
     description
     :   {$methodReturnDesc}{$hasDesc}
 
-{$methodDescription}{hasDesc$}{$hasExample}
+    **{$className}{$connector}{$methodName} Description**
+
+    {$methodDescription}{hasDesc$}{$hasExample}
 
 !!! example "Example"
     {$methodExample}{hasExample$}
+
+---
diff --git a/src/Samsara/Roster/Processors/InterfaceInlineProcessor.php b/src/Samsara/Roster/Processors/InterfaceInlineProcessor.php
@@ -25,6 +25,10 @@ public function compile(): string
 
         $description = (empty($this->docBlock->description) ? '*No description available*' : $this->docBlock->description);
 
+        if (TemplateFactory::getMkDocs()) {
+            $description = str_replace(PHP_EOL, PHP_EOL.'    ', $description);
+        }
+
         $this->templateProcessor->supplyReplacement('interfaceName', $this->interface->getShortName());
         $this->templateProcessor->supplyReplacement('interfaceNamespace', $this->interface->getNamespaceName());
         $this->templateProcessor->supplyReplacement('interfaceDesc', $description);

diff --git a/src/Samsara/Roster/Processors/MethodArgumentDetailProcessor.php b/src/Samsara/Roster/Processors/MethodArgumentDetailProcessor.php
@@ -50,6 +50,10 @@ public function compile(): string
                 $desc = $this->tags[$tagAccessor]->description;
             }
 
+            if (TemplateFactory::getMkDocs()) {
+                $desc = str_replace(PHP_EOL, PHP_EOL.'    ', $desc);
+            }
+
             $template->supplyReplacement('argDesc', $desc);
 
             $argTypeDoc = '';

diff --git a/src/Samsara/Roster/Processors/MethodProcessor.php b/src/Samsara/Roster/Processors/MethodProcessor.php
@@ -52,8 +52,14 @@ public function compile(): string
         }
 
         if (!empty($this->docBlock->description)) {
+            if (TemplateFactory::getMkDocs()) {
+                $methodDesc = str_replace(PHP_EOL, PHP_EOL.'    ', $this->docBlock->description);
+            } else {
+                $methodDesc = $this->docBlock->description;
+            }
+
             $this->templateProcessor->markHas('Desc');
-            $this->templateProcessor->supplyReplacement('methodDescription', $this->docBlock->description);
+            $this->templateProcessor->supplyReplacement('methodDescription', $methodDesc);
         }
 
         $returnType = (string)$this->method->getReturnType();

diff --git a/src/Samsara/Roster/Processors/TraitInlineProcessor.php b/src/Samsara/Roster/Processors/TraitInlineProcessor.php
@@ -26,6 +26,10 @@ public function compile(): string
 
         $description = (empty($this->docBlock->description) ? '*No description available*' : $this->docBlock->description);
 
+        if (TemplateFactory::getMkDocs()) {
+            $description = str_replace(PHP_EOL, PHP_EOL.'    ', $description);
+        }
+
         $this->templateProcessor->supplyReplacement('traitName', $this->trait->getShortName());
         $this->templateProcessor->supplyReplacement('traitNamespace', $this->trait->getNamespaceName());
         $this->templateProcessor->supplyReplacement('traitDesc', $description);
@@ -54,6 +58,10 @@ public function compile(): string
             $methodDoc = new DocBlockProcessor($method->getDocComment());
             $originalMethodDesc = (empty($methodDoc->description) ? '*No description available*' : $methodDoc->description);
 
+            if (TemplateFactory::getMkDocs()) {
+                $originalMethodDesc = str_replace(PHP_EOL, PHP_EOL.'    ', $originalMethodDesc);
+            }
+
             $aliasTemplate->supplyReplacement('originalMethod', $original);
             $aliasTemplate->supplyReplacement('newMethod', $alias);
             $aliasTemplate->supplyReplacement('originalMethodDesc', $originalMethodDesc);

diff --git a/src/Samsara/Roster/TemplateFactory.php b/src/Samsara/Roster/TemplateFactory.php
@@ -21,6 +21,8 @@ class TemplateFactory
     private static array $writtenFiles = [];
     private static bool $preferSource = true;
     private static int $visibilityLevel = 1;
+    private static bool $mkdocs = false;
+    private static string $theme = 'sphinx';
 
     public static function setPreferSource(bool $preferSource)
     {
@@ -32,6 +34,26 @@ public static function getPreferSource(): bool
         return self::$preferSource;
     }
 
+    public static function setMkDocs(bool $mkdocs)
+    {
+        self::$mkdocs = $mkdocs;
+    }
+
+    public static function getMkDocs(): bool
+    {
+        return self::$mkdocs;
+    }
+
+    public static function setTheme(bool $theme)
+    {
+        self::$theme = $theme;
+    }
+
+    public static function getTheme(): string
+    {
+        return self::$theme;
+    }
+
     public static function setVisibilityLevel(int $visibilityLevel)
     {
         self::$visibilityLevel = $visibilityLevel;