Skip to content

Commit

Permalink
feat: Add Sphinx reference generation
Browse files Browse the repository at this point in the history
  • Loading branch information
Estrada Irribarra, Rodrigo Andres committed Oct 22, 2024
1 parent 658d337 commit d6b8ddd
Show file tree
Hide file tree
Showing 29 changed files with 4,185 additions and 45 deletions.
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)

if "%1" == "" goto help

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
Binary file added docs/reference/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/reference/.doctrees/index.doctree
Binary file not shown.
111 changes: 111 additions & 0 deletions docs/reference/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
.. StoryCraftr documentation master file, created by
sphinx-quickstart on Tue Oct 22 14:46:11 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. StoryCraftr documentation master file
.. StoryCraftr documentation master file
Welcome to StoryCraftr's documentation!
========================================

.. toctree::
:maxdepth: 2
:caption: Contents:

modules

Reference Guide
===============

Agent Module
------------

.. automodule:: storycraftr.agent.agents
:members:

.. automodule:: storycraftr.agent.chapters
:members:

.. automodule:: storycraftr.agent.iterate
:members:

.. automodule:: storycraftr.agent.outline
:members:

.. automodule:: storycraftr.agent.retrieval
:members:

.. automodule:: storycraftr.agent.worldbuilding
:members:

Command Module
--------------

.. click:: storycraftr.cmd.cli:cli
:prog: storycraftr
:show-nested:

.. automodule:: storycraftr.cmd.chapters
:members:

.. automodule:: storycraftr.cmd.chat
:members:

.. automodule:: storycraftr.cmd.iterate
:members:

.. automodule:: storycraftr.cmd.outline
:members:

.. automodule:: storycraftr.cmd.publish
:members:

.. automodule:: storycraftr.cmd.worldbuilding
:members:

Prompts Module
--------------

.. automodule:: storycraftr.prompts.chapters
:members:

.. automodule:: storycraftr.prompts.core
:members:

.. automodule:: storycraftr.prompts.iterate
:members:

.. automodule:: storycraftr.prompts.outline
:members:

.. automodule:: storycraftr.prompts.permute
:members:

.. automodule:: storycraftr.prompts.worldbuilding
:members:

Utils Module
------------

.. automodule:: storycraftr.utils.core
:members:

.. automodule:: storycraftr.utils.markdown
:members:

.. automodule:: storycraftr.utils.pdf
:members:

.. automodule:: storycraftr.utils.cli
:members:

.. automodule:: storycraftr.utils.state
:members:

Templates
---------

(Si necesitas documentar algo relacionado con templates, puedes añadirlo aquí.)

Loading

0 comments on commit d6b8ddd

Please sign in to comment.