Skip to content

Commit

Permalink
Merge pull request #108 from filip-michalsky/documentation
Browse files Browse the repository at this point in the history
Docstrings improvement and api-website updates
  • Loading branch information
filip-michalsky authored Mar 3, 2024
2 parents 8bc7bf4 + e1d10b0 commit b319d20
Show file tree
Hide file tree
Showing 85 changed files with 3,371 additions and 768 deletions.
Binary file modified api-website/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified api-website/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/modules.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/run_api.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
14 changes: 14 additions & 0 deletions api-website/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,20 @@ Welcome to SalesGPT's documentation!
:maxdepth: 2
:caption: Contents:

Agents <salesgpt/salesgpt.agents>
Chains <salesgpt/salesgpt.chains>
Logger <salesgpt/salesgpt.logger>
Parsers <salesgpt/salesgpt.parsers>
Prompts <salesgpt/salesgpt.prompts>
Prompts_cn <salesgpt/salesgpt.prompts_cn>
SalesGPT API <salesgpt/salesgpt.salesgptapi>
Stages <salesgpt/salesgpt.stages>
Templates <salesgpt/salesgpt.templates>
Tools <salesgpt/salesgpt.tools>
Version <salesgpt/salesgpt.version>

.. role:: red-text

:red-text:`We have just begun building this website and are still actively working on it. Any suggestions to improve readability / desired contents are welcome! Please contact @chemik-bit on Github.`

Indices and tables
Expand All @@ -19,3 +32,4 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

4 changes: 1 addition & 3 deletions api-website/_build/html/_sources/modules.rst.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
SalesGPT
salesgpt
========

.. toctree::
:maxdepth: 4

run
run_api
salesgpt
7 changes: 0 additions & 7 deletions api-website/_build/html/_sources/run.rst.txt

This file was deleted.

7 changes: 0 additions & 7 deletions api-website/_build/html/_sources/run_api.rst.txt

This file was deleted.

7 changes: 7 additions & 0 deletions api-website/_build/html/_sources/salesgpt/modules.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt
========

.. toctree::
:maxdepth: 4

salesgpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt.agents module
======================

.. automodule:: salesgpt.agents
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt.chains module
======================

.. automodule:: salesgpt.chains
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt.logger module
======================

.. automodule:: salesgpt.logger
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt.parsers module
=======================

.. automodule:: salesgpt.parsers
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt.prompts module
=======================

.. automodule:: salesgpt.prompts
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt.prompts\_cn module
===========================

.. automodule:: salesgpt.prompts_cn
:members:
:undoc-members:
:show-inheritance:
29 changes: 29 additions & 0 deletions api-website/_build/html/_sources/salesgpt/salesgpt.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
salesgpt package
================

Submodules
----------

.. toctree::
:maxdepth: 4
:caption: Contents:

salesgpt.agents
salesgpt.chains
salesgpt.logger
salesgpt.parsers
salesgpt.prompts
salesgpt.prompts_cn
salesgpt.salesgptapi
salesgpt.stages
salesgpt.templates
salesgpt.tools
salesgpt.version

Module contents
---------------

.. automodule:: salesgpt
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt.salesgptapi module
===========================

.. automodule:: salesgpt.salesgptapi
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt.stages module
======================

.. automodule:: salesgpt.stages
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt.templates module
=========================

.. automodule:: salesgpt.templates
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt.tools module
=====================

.. automodule:: salesgpt.tools
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
salesgpt.version module
=======================

.. automodule:: salesgpt.version
:members:
:undoc-members:
:show-inheritance:
24 changes: 23 additions & 1 deletion api-website/_build/html/_static/custom.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
.red-text {
color: red;
}
}

.wy-menu-extra {
margin-top: 20px; /* Adjust the space above the button */
text-align: center; /* Center the button */
}

.btn-primary {
background-color: #000000; /* Change to black */
color: #FFFFFF; /* Change to white */
border-radius: 5px;
padding: 10px 15px;
display: inline-block;
text-decoration: none;
box-shadow: 0 2px 5px rgba(0,0,0,0.2);
transition: background-color 0.3s ease;
}

.btn-primary:hover, .btn-primary:focus {
background-color: #0000FF; /* Keep the hover color blue */
color: #FFFFFF; /* Change the hover text color to white */
text-decoration: none;
}
Loading

0 comments on commit b319d20

Please sign in to comment.