feat: Add Sphinx reference generation

raestrada · Oct 22, 2024 · 28368a1 · 28368a1
1 parent 36536c9
commit 28368a1
Show file tree

Hide file tree

Showing 29 changed files with 3,140 additions and 1,802 deletions.
diff --git a/.vscode-test.mjs b/.vscode-test.mjs
@@ -1,5 +1,5 @@
-import { defineConfig } from '@vscode/test-cli';
+import { defineConfig } from "@vscode/test-cli";
 
 export default defineConfig({
-	files: 'out/test/**/*.test.js',
+  files: "out/test/**/*.test.js",
 });
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,8 +1,8 @@
 {
-	// See http://go.microsoft.com/fwlink/?LinkId=827846
-	// for the documentation about the extensions.json format
-	"recommendations": [
-		"dbaeumer.vscode-eslint",
-		"ms-vscode.extension-test-runner"
-	]
+  // See http://go.microsoft.com/fwlink/?LinkId=827846
+  // for the documentation about the extensions.json format
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "ms-vscode.extension-test-runner"
+  ]
 }
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -3,19 +3,15 @@
 // Hover to view descriptions of existing attributes.
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
-	"version": "0.2.0",
-	"configurations": [
-		{
-			"name": "Run Extension",
-			"type": "extensionHost",
-			"request": "launch",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}"
-			],
-			"outFiles": [
-				"${workspaceFolder}/out/**/*.js"
-			],
-			"preLaunchTask": "${defaultBuildTask}"
-		}
-	]
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+      "outFiles": ["${workspaceFolder}/out/**/*.js"],
+      "preLaunchTask": "${defaultBuildTask}"
+    }
+  ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,11 +1,11 @@
 // Place your settings in this file to overwrite default and user settings.
 {
-	"files.exclude": {
-		"out": false // set this to true to hide the "out" folder with the compiled JS files
-	},
-	"search.exclude": {
-		"out": true // set this to false to include "out" folder in search results
-	},
-	// Turn off tsc task auto detection since we have the necessary tasks as npm scripts
-	"typescript.tsc.autoDetect": "off"
+  "files.exclude": {
+    "out": false // set this to true to hide the "out" folder with the compiled JS files
+  },
+  "search.exclude": {
+    "out": true // set this to false to include "out" folder in search results
+  },
+  // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+  "typescript.tsc.autoDetect": "off"
 }
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -1,20 +1,20 @@
 // See https://go.microsoft.com/fwlink/?LinkId=733558
 // for the documentation about the tasks.json format
 {
-	"version": "2.0.0",
-	"tasks": [
-		{
-			"type": "npm",
-			"script": "watch",
-			"problemMatcher": "$tsc-watch",
-			"isBackground": true,
-			"presentation": {
-				"reveal": "never"
-			},
-			"group": {
-				"kind": "build",
-				"isDefault": true
-			}
-		}
-	]
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "watch",
+      "problemMatcher": "$tsc-watch",
+      "isBackground": true,
+      "presentation": {
+        "reveal": "never"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,45 +1,63 @@
 # Changelog
 
 ## [0.7.0-alpha3] - 2024-03-14
+
 ### Added
-- **Interactive Chat with Commands**: Enhanced chat functionality now allows users to interact with StoryCraftr using direct command prompts, helping with outlining, world-building, and chapter writing. 
+
+- **Interactive Chat with Commands**: Enhanced chat functionality now allows users to interact with StoryCraftr using direct command prompts, helping with outlining, world-building, and chapter writing.
 - **Documentation-Driven Chat**: StoryCraftr's documentation is fully loaded into the system, allowing users to ask for help with commands directly from within the chat interface.
 - **Improved User Interface**: New UI elements for an enhanced interactive experience. Chat commands and documentation queries are more intuitive.
 
 ![Chat Example](https://res.cloudinary.com/dyknhuvxt/image/upload/v1729551304/chat-example_hdo9yu.png)
 
 ## [0.6.1-alpha2] - 2024-02-29
+
 ### Added
+
 - **VSCode Extension Alpha**: Launched an alpha version of the StoryCraftr extension for VSCode, which automatically detects the `storycraftr.json` file in the workspace and launches a terminal for interacting with the StoryCraftr CLI.
 
 ## [0.6.0-alpha1] - 2024-02-22
+
 ### Added
+
 - **VSCode Terminal Chat**: Chat functionality embedded into the VSCode extension, allowing users to launch a terminal directly from VSCode and interact with StoryCraftr.
 
 ## [0.5.2-alpha1] - 2024-02-15
+
 ### Added
+
 - **Multi-command Iteration**: New CLI functionality allowing iterative refinement of plot points, character motivations, and chapter structures.
 
 ## [0.5.0-alpha1] - 2024-02-01
+
 ### Added
+
 - **Insert Chapter Command**: Users can now insert chapters between existing ones and automatically renumber subsequent chapters for seamless story progression.
 
 ## [0.4.0] - 2024-01-20
+
 ### Added
+
 - **Story Iteration**: Introduced the ability to iterate over various aspects of your book, including refining character motivations and checking plot consistency.
 - **Flashback Insertion**: Users can now insert flashback chapters that automatically adjust surrounding chapters.
 
 ## [0.3.0] - 2024-01-10
+
 ### Added
-- **Outline Generation**: Generate detailed story outlines based on user-provided prompts.  
+
+- **Outline Generation**: Generate detailed story outlines based on user-provided prompts.
 - **World-Building**: New commands to generate history, geography, culture, and technology elements of your book’s world.
 
 ## [0.2.0] - 2023-12-15
+
 ### Added
+
 - **Behavior Guidance**: A behavior file that helps guide the AI's understanding of the writing style, themes, and narrative focus of your novel.
 
 ## [0.1.0] - 2023-11-28
+
 ### Added
+
 - **Initial Release**: Base functionalities including chapter writing, character summaries, and basic outline generation.
 
 ---

diff --git a/README.md b/README.md
@@ -118,18 +118,22 @@ help()
 We are excited to introduce the **StoryCraftr** VSCode extension, designed to seamlessly integrate the StoryCraftr CLI into your development environment. This extension allows you to interact with StoryCraftr directly from VSCode, offering powerful tools for novel writing and AI-assisted creativity.
 
 ### Key Features:
+
 - **Auto-detection**: Automatically detects if `storycraftr.json` is present in the project root, ensuring the project is ready to use.
 - **Integrated Chat**: Start interactive AI-powered chat sessions for brainstorming and refining your novel without leaving VSCode.
 - **Simplified Setup**: If StoryCraftr or its dependencies (Python, pipx) are not installed, the extension assists you in setting them up.
 
 ### Installation:
+
 You can install the StoryCraftr VSCode extension directly from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=StoryCraftr.storycraftr).
 
 ### Usage:
+
 Once installed, the extension will:
+
 1. Check if `storycraftr.json` exists in the root of your project.
 2. If it exists, you can start interacting with StoryCraftr by launching a terminal with the `chat` command using:
-    - **Command Palette**: Run `Start StoryCraftr Chat`.
+   - **Command Palette**: Run `Start StoryCraftr Chat`.
 3. If not installed, it will guide you through installing Python, pipx, and StoryCraftr to get started.
 
 Explore more about the [StoryCraftr CLI](https://github.com/raestrada/storycraftr) and see how it can boost your storytelling workflow.

diff --git a/docs/chat.md b/docs/chat.md
@@ -16,17 +16,16 @@ This will provide a list of available commands and their usage.
 
 When interacting with the StoryCraftr assistant, it's important to enclose multi-word inputs in quotes to ensure they are processed as a single cohesive prompt. For example:
 
-```[You]: "Explain how Zevid manipulates the elite using their own biotechnology in the rebellion."```
+`[You]: "Explain how Zevid manipulates the elite using their own biotechnology in the rebellion."`
 
 This ensures that the assistant treats the entire input as one argument rather than splitting it into separate terms.
 
 **Bonus!** The assistant is pre-loaded with the full StoryCraftr documentation, so you can ask it about any command or feature. For example, if you need help with a specific command:
 
-```[You]: "Show me how to use the insert-chapter command and its parameters."```
+`[You]: "Show me how to use the insert-chapter command and its parameters."`
 
 This will provide you with clear guidance directly within the chat, ensuring you have everything you need to use StoryCraftr to its full potential!
 
-
 ## Overview
 
 The **Chat** feature in **StoryCraftr** allows you to interact directly with the AI assistant to brainstorm ideas, refine content, or improve any aspect of your book in real time. The feature includes the ability to prompt specific commands related to story development, iterative refinement, and world-building, all from within the chat environment. This guide will help you get started with using the chat feature effectively.

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -235,27 +235,31 @@ Replace `"book_path"` with the actual name of your book. This will open an inter
 In this interactive chat, you can ask the assistant to help with both your book and StoryCraftr’s commands. Here are three examples:
 
 1. **Asking about your book:**
-    ```bash
-    [You]: "Explain how Captain Blackmane uses deception to take control of the hidden pirate fleet."
-    ```
-    ```bash
-    [Assistant]: "Captain Blackmane’s cunning involves luring rival pirate factions into a false alliance. He promises them access to the treasure they’ve long sought, only to reveal his true plan of betrayal, securing the fleet for himself."
-    ```
+
+   ```bash
+   [You]: "Explain how Captain Blackmane uses deception to take control of the hidden pirate fleet."
+   ```
+
+   ```bash
+   [Assistant]: "Captain Blackmane’s cunning involves luring rival pirate factions into a false alliance. He promises them access to the treasure they’ve long sought, only to reveal his true plan of betrayal, securing the fleet for himself."
+   ```
 
 2. **Running a command:**
-    ```bash
-    [You]: "Generate the character summary for Captain Blackmane."
-    ```
-    ```bash
-    [Assistant]: "To generate a character summary for Captain Blackmane, use the following command:
-    `storycraftr outline character-summary "Summarize Captain Blackmane, a ruthless pirate leader with a talent for deception."`"
-    ```
+
+   ```bash
+   [You]: "Generate the character summary for Captain Blackmane."
+   ```
+
+   ```bash
+   [Assistant]: "To generate a character summary for Captain Blackmane, use the following command:
+   `storycraftr outline character-summary "Summarize Captain Blackmane, a ruthless pirate leader with a talent for deception."`"
+   ```
 
 3. **Executing any StoryCraftr command directly in the chat:**
 
-    ```bash
-    [You]: !iterate check-names "Check character names for consistency."
-    ```
+   ```bash
+   [You]: !iterate check-names "Check character names for consistency."
+   ```
 
 In this session, you can seamlessly combine book content with command generation and execution, streamlining your writing process and giving you real-time insights.
 
@@ -273,7 +277,6 @@ exit()
 
 This will gracefully close the chat session and return you to your terminal.
 
-
 ## Learn More About Writing
 
 The ideas in this tool are heavily inspired by [Brandon Sanderson’s Laws of Magic and Writing](https://www.brandonsanderson.com/the-law-of-writing). StoryCraftr is designed to help you implement these concepts while crafting well-structured stories with strong character arcs and consistent plot development.

diff --git a/docs/index.html b/docs/index.html
@@ -1,7 +1,11 @@
 <!doctype html>
 <html lang="en">
   <head>
-    <link rel="icon" type="image/png" href="https://res.cloudinary.com/dyknhuvxt/image/upload/f_auto,q_auto/ofhhkf6f7bryfgvbxxwc">
+    <link
+      rel="icon"
+      type="image/png"
+      href="https://res.cloudinary.com/dyknhuvxt/image/upload/f_auto,q_auto/ofhhkf6f7bryfgvbxxwc"
+    />
     <!-- Google tag (gtag.js) -->
     <script
       async
@@ -280,8 +284,7 @@
       }
 
       @media (max-width: 768px) {
-        .vscode-logo
-        .openai-logo,
+        .vscode-logo .openai-logo,
         .github-logo {
           display: none; /* Ocultar los logos en pantallas más pequeñas */
         }
@@ -494,16 +497,28 @@ <h2>Join Our Community 🚀</h2>
       <p>
         Follow us on
         <a href="https://twitter.com/Storycraftrapp">
-          <img src="https://pbs.twimg.com/media/F1zrsq8XsAUU7Lw?format=jpg&name=medium" alt="X logo" style="width: 20px; height: 20px; vertical-align: middle;"> for the latest updates
+          <img
+            src="https://pbs.twimg.com/media/F1zrsq8XsAUU7Lw?format=jpg&name=medium"
+            alt="X logo"
+            style="width: 20px; height: 20px; vertical-align: middle"
+          />
+          for the latest updates
         </a>
       </p>
       <p>
         Join us on
-        <a href="https://join.slack.com/t/storycraftr/shared_invite/zt-2tafmvgrk-HYNs~cxhlFCnmYOTFRZZTA">
-          <img src="https://scontent.fscl38-1.fna.fbcdn.net/v/t39.30808-1/449769914_794996782768282_7376581937570946428_n.jpg?stp=dst-jpg_s480x480&_nc_cat=1&ccb=1-7&_nc_sid=f4b9fd&_nc_eui2=AeHjODXAWXyBKX0zb5C_bm1OhhX-bdQFJ_CGFf5t1AUn8FpJUv9V-JqfUB7dnt-WfMo&_nc_ohc=XB4hNHkYOXMQ7kNvgEn_HkE&_nc_zt=24&_nc_ht=scontent.fscl38-1.fna&_nc_gid=A0Gvt4XM7DGLWYHV12fRTPs&oh=00_AYAWyh3RBTG6HdKKgYhaZGT9wDmPuWo62y0K3HmJc0XOBg&oe=671CB275" alt="Slack logo" style="width: 20px; height: 20px; vertical-align: middle;"> Slack
+        <a
+          href="https://join.slack.com/t/storycraftr/shared_invite/zt-2tafmvgrk-HYNs~cxhlFCnmYOTFRZZTA"
+        >
+          <img
+            src="https://scontent.fscl38-1.fna.fbcdn.net/v/t39.30808-1/449769914_794996782768282_7376581937570946428_n.jpg?stp=dst-jpg_s480x480&_nc_cat=1&ccb=1-7&_nc_sid=f4b9fd&_nc_eui2=AeHjODXAWXyBKX0zb5C_bm1OhhX-bdQFJ_CGFf5t1AUn8FpJUv9V-JqfUB7dnt-WfMo&_nc_ohc=XB4hNHkYOXMQ7kNvgEn_HkE&_nc_zt=24&_nc_ht=scontent.fscl38-1.fna&_nc_gid=A0Gvt4XM7DGLWYHV12fRTPs&oh=00_AYAWyh3RBTG6HdKKgYhaZGT9wDmPuWo62y0K3HmJc0XOBg&oe=671CB275"
+            alt="Slack logo"
+            style="width: 20px; height: 20px; vertical-align: middle"
+          />
+          Slack
         </a>
       </p>
       <p>&copy; 2024 StoryCraftr</p>
-    </footer>    
+    </footer>
   </body>
 </html>