Skip to content

Commit

Permalink
Deployed 2a629c5 with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
mmacy committed Feb 12, 2024
1 parent b09a8ee commit bc2b0b4
Show file tree
Hide file tree
Showing 7 changed files with 318 additions and 1,463 deletions.
466 changes: 172 additions & 294 deletions get_started/index.html

Large diffs are not rendered by default.

11 changes: 5 additions & 6 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1056,25 +1056,24 @@ <h1 id="welcome">Welcome</h1>
<p>Welcome to Marsh's totally unofficial and totally unsupported documentation for the OpenAI Python library.</p>
<div class="grid cards">
<ul>
<li><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.8 200.5c-7.7-30.9-22.3-54.2-53.4-54.2h-40.1v47.4c0 36.8-31.2 67.8-66.8 67.8H172.7c-29.2 0-53.4 25-53.4 54.3v101.8c0 29 25.2 46 53.4 54.3 33.8 9.9 66.3 11.7 106.8 0 26.9-7.8 53.4-23.5 53.4-54.3v-40.7H226.2v-13.6h160.2c31.1 0 42.6-21.7 53.4-54.2 11.2-33.5 10.7-65.7 0-108.6zM286.2 404c11.1 0 20.1 9.1 20.1 20.3 0 11.3-9 20.4-20.1 20.4-11 0-20.1-9.2-20.1-20.4.1-11.3 9.1-20.3 20.1-20.3zM167.8 248.1h106.8c29.7 0 53.4-24.5 53.4-54.3V91.9c0-29-24.4-50.7-53.4-55.6-35.8-5.9-74.7-5.6-106.8.1-45.2 8-53.4 24.7-53.4 55.6v40.7h106.9v13.6h-147c-31.1 0-58.3 18.7-66.8 54.2-9.8 40.7-10.2 66.1 0 108.6 7.6 31.6 25.7 54.2 56.8 54.2H101v-48.8c0-35.3 30.5-66.4 66.8-66.4zm-6.7-142.6c-11.1 0-20.1-9.1-20.1-20.3.1-11.3 9-20.4 20.1-20.4 11 0 20.1 9.2 20.1 20.4s-9 20.3-20.1 20.3z"/></svg></span> <a href="openai/">OpenAI Python library reference</a></li>
<li><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15 4a8 8 0 0 1 8 8 8 8 0 0 1-8 8 8 8 0 0 1-8-8 8 8 0 0 1 8-8m0 2a6 6 0 0 0-6 6 6 6 0 0 0 6 6 6 6 0 0 0 6-6 6 6 0 0 0-6-6m-1 2h1.5v3.78l2.33 2.33-1.06 1.06L14 12.4V8M2 18a1 1 0 0 1-1-1 1 1 0 0 1 1-1h3.83c.31.71.71 1.38 1.17 2H2m1-5a1 1 0 0 1-1-1 1 1 0 0 1 1-1h2.05L5 12l.05 1H3m1-5a1 1 0 0 1-1-1 1 1 0 0 1 1-1h3c-.46.62-.86 1.29-1.17 2H4Z"/></svg></span> <a href="get_started/">Get started with the library</a></li>
<li><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.8 200.5c-7.7-30.9-22.3-54.2-53.4-54.2h-40.1v47.4c0 36.8-31.2 67.8-66.8 67.8H172.7c-29.2 0-53.4 25-53.4 54.3v101.8c0 29 25.2 46 53.4 54.3 33.8 9.9 66.3 11.7 106.8 0 26.9-7.8 53.4-23.5 53.4-54.3v-40.7H226.2v-13.6h160.2c31.1 0 42.6-21.7 53.4-54.2 11.2-33.5 10.7-65.7 0-108.6zM286.2 404c11.1 0 20.1 9.1 20.1 20.3 0 11.3-9 20.4-20.1 20.4-11 0-20.1-9.2-20.1-20.4.1-11.3 9.1-20.3 20.1-20.3zM167.8 248.1h106.8c29.7 0 53.4-24.5 53.4-54.3V91.9c0-29-24.4-50.7-53.4-55.6-35.8-5.9-74.7-5.6-106.8.1-45.2 8-53.4 24.7-53.4 55.6v40.7h106.9v13.6h-147c-31.1 0-58.3 18.7-66.8 54.2-9.8 40.7-10.2 66.1 0 108.6 7.6 31.6 25.7 54.2 56.8 54.2H101v-48.8c0-35.3 30.5-66.4 66.8-66.4zm-6.7-142.6c-11.1 0-20.1-9.1-20.1-20.3.1-11.3 9-20.4 20.1-20.4 11 0 20.1 9.2 20.1 20.4s-9 20.3-20.1 20.3z"/></svg></span> <a href="openai/">OpenAI Python library reference</a></li>
</ul>
</div>
<h2 id="about-these-docs">About these docs</h2>
<p class="annotate">The docs are officially unofficial and unsupported, but you're welcome to use and improve them until OpenAI brings up their own (1) or they ask me to take these down.</p>
<p class="annotate">These docs are officially unofficial and unsupported, but you're welcome to use and improve them until OpenAI brings up their own (1) or they ask me to take them down.</p>
<ol>
<li>I'll likely decommission this site when OpenAI <a href="https://community.openai.com/t/where-is-the-documentation-for-the-python-openai-sdk/583643">publishes their own Python API reference</a>.</li>
</ol>
<h3 id="unofficial">Unofficial</h3>
<p><strong>Neither this site nor its contents are officially endorsed by OpenAI.</strong> Other than being a customer, I have no affiliation with OpenAI. I've published this documentation because I wanted full API reference for the Python library. You might find it useful, too.</p>
<p>You might instead prefer to use OpenAI's official docs on <a href="https://platform.openai.com">OpenAI's official documentation site</a> and in the upstream <a href="https://github.com/openai/openai-python">openai/openai-python</a> repository on GitHub, however.</p>
<h3 id="unsupported">Unsupported</h3>
<p><strong>The documentation on this site is provided AS-IS and with NO WARRANTY.</strong> The API reference on this site is generated from the OpenAI Python library's code, but I make no promises nor guarantee these docs reflect the current, past, or future state of the library.</p>
<p class="annotate">That said, I use these docs myself and thus intend to keep them (mostly) current, but there's no automation pulling content from their repo to this fork. (1)</p>
<p><strong>The documentation on this site is provided AS-IS with NO WARRANTY.</strong> The API reference is indeed generated from the OpenAI Python library's code, but I make no promises nor guarantee these docs reflect the current, past, or future state of the library.</p>
<p class="annotate">That said, I use these docs myself and thus intend to keep them (mostly) current. However, there's no automation pulling content from their repo to this fork. (1)</p>
<ol>
<li>This means you might encounter inaccuracies or you might not find what you think should be here. In either case, you should refer to <a href="https://github.com/openai/openai-python">openai/openai-python</a> as the source of truth.</li>
<li>That means you might encounter inaccuracies or you might not find what you think should be here. In either case, you should refer to <a href="https://github.com/openai/openai-python">openai/openai-python</a> as the source of truth.</li>
</ol>
<hr />
<div class="admonition quote">
<p class="admonition-title">Quote</p>
<p>If these docs help you, yay! If they don't, don't use 'em. Enjoy! <em><a href="https://github.com/mmacy">Marsh</a></em></p>
Expand Down
Loading

0 comments on commit bc2b0b4

Please sign in to comment.