Skip to content

Commit eb9ecc1

Browse files
committed
Update the docs
1 parent 96aaf40 commit eb9ecc1

9 files changed

+48
-28
lines changed
0 Bytes
Binary file not shown.
588 Bytes
Binary file not shown.
-75 Bytes
Binary file not shown.

docs/latest/_sources/getting_started.rst.txt

+13-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ To install using pip, run:
1414
1515
pip install o365
1616
17+
or use uv:
18+
19+
.. code-block:: console
20+
21+
uv add o365
22+
1723
Requirements: >= Python 3.9
1824

1925
Project dependencies installed by pip:
@@ -30,12 +36,18 @@ Latest Development Version (GitHub)
3036
The latest development version is available on `GitHub <https://github.com/O365/python-o365>`_.
3137
This version may include new features but could be unstable. **Use at your own risk**.
3238

33-
To install from GitHub, run:
39+
Using pip, run:
3440

3541
.. code-block:: console
3642
3743
pip install git+https://github.com/O365/python-o365.git
3844
45+
Or with uv, run:
46+
47+
.. code-block:: console
48+
49+
uv add "o365 @ git+https://github.com/O365/python-o365"
50+
3951
Basic Usage
4052
===========
4153

docs/latest/_sources/overview.rst.txt

+11-11
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,6 @@ Core developers
2020

2121
We are always open to new pull requests!
2222

23-
Rebuilding HTML Docs
24-
--------------------
25-
* Install ``sphinx`` python library:
26-
27-
.. code-block:: console
28-
29-
pip install sphinx
30-
31-
* Run the shell script ``build_docs.sh``, or copy the command from the file when using on Windows
32-
3323
Quick example
3424
-------------
3525
Here is a simple example showing how to send an email using python-o365.
@@ -68,4 +58,14 @@ This project was also a learning resource for us. This is a list of not so commo
6858
* Factory paradigm
6959
* Package organization
7060
* Timezone conversion and timezone aware datetimes
71-
* Etc. (see the code!)
61+
* Etc. (see the code!)
62+
63+
Rebuilding HTML Docs
64+
--------------------
65+
* Install ``sphinx`` python library:
66+
67+
.. code-block:: console
68+
69+
pip install sphinx
70+
71+
* Run the shell script ``build_docs.sh``, or copy the command from the file when using on Windows

docs/latest/getting_started.html

+9-1
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,10 @@ <h3>Stable Version (PyPI)<a class="headerlink" href="#stable-version-pypi" title
111111
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">pip install o365</span>
112112
</pre></div>
113113
</div>
114+
<p>or use uv:</p>
115+
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">uv add o365</span>
116+
</pre></div>
117+
</div>
114118
<p>Requirements: &gt;= Python 3.9</p>
115119
<p>Project dependencies installed by pip:</p>
116120
<ul class="simple">
@@ -126,10 +130,14 @@ <h3>Stable Version (PyPI)<a class="headerlink" href="#stable-version-pypi" title
126130
<h3>Latest Development Version (GitHub)<a class="headerlink" href="#latest-development-version-github" title="Link to this heading"></a></h3>
127131
<p>The latest development version is available on <a class="reference external" href="https://github.com/O365/python-o365">GitHub</a>.
128132
This version may include new features but could be unstable. <strong>Use at your own risk</strong>.</p>
129-
<p>To install from GitHub, run:</p>
133+
<p>Using pip, run:</p>
130134
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">pip install git+https://github.com/O365/python-o365.git</span>
131135
</pre></div>
132136
</div>
137+
<p>Or with uv, run:</p>
138+
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">uv add &quot;o365 @ git+https://github.com/O365/python-o365&quot;</span>
139+
</pre></div>
140+
</div>
133141
</section>
134142
</section>
135143
<section id="basic-usage">

docs/latest/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ <h1>Welcome to O365’s documentation!<a class="headerlink" href="#welcome-to-o3
8484
<ul>
8585
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
8686
<li class="toctree-l2"><a class="reference internal" href="overview.html#core-developers">Core developers</a></li>
87-
<li class="toctree-l2"><a class="reference internal" href="overview.html#rebuilding-html-docs">Rebuilding HTML Docs</a></li>
8887
<li class="toctree-l2"><a class="reference internal" href="overview.html#quick-example">Quick example</a></li>
8988
<li class="toctree-l2"><a class="reference internal" href="overview.html#why-choose-o365">Why choose O365?</a></li>
89+
<li class="toctree-l2"><a class="reference internal" href="overview.html#rebuilding-html-docs">Rebuilding HTML Docs</a></li>
9090
</ul>
9191
</li>
9292
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a><ul>

docs/latest/overview.html

+13-13
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@
4848
<ul class="current">
4949
<li class="toctree-l1 current"><a class="current reference internal" href="#">Overview</a><ul>
5050
<li class="toctree-l2"><a class="reference internal" href="#core-developers">Core developers</a></li>
51-
<li class="toctree-l2"><a class="reference internal" href="#rebuilding-html-docs">Rebuilding HTML Docs</a></li>
5251
<li class="toctree-l2"><a class="reference internal" href="#quick-example">Quick example</a></li>
5352
<li class="toctree-l2"><a class="reference internal" href="#why-choose-o365">Why choose O365?</a></li>
53+
<li class="toctree-l2"><a class="reference internal" href="#rebuilding-html-docs">Rebuilding HTML Docs</a></li>
5454
</ul>
5555
</li>
5656
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
@@ -103,18 +103,6 @@ <h2>Core developers<a class="headerlink" href="#core-developers" title="Link to
103103
</ul>
104104
<p>We are always open to new pull requests!</p>
105105
</section>
106-
<section id="rebuilding-html-docs">
107-
<h2>Rebuilding HTML Docs<a class="headerlink" href="#rebuilding-html-docs" title="Link to this heading"></a></h2>
108-
<ul class="simple">
109-
<li><p>Install <code class="docutils literal notranslate"><span class="pre">sphinx</span></code> python library:</p></li>
110-
</ul>
111-
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">pip install sphinx</span>
112-
</pre></div>
113-
</div>
114-
<ul class="simple">
115-
<li><p>Run the shell script <code class="docutils literal notranslate"><span class="pre">build_docs.sh</span></code>, or copy the command from the file when using on Windows</p></li>
116-
</ul>
117-
</section>
118106
<section id="quick-example">
119107
<h2>Quick example<a class="headerlink" href="#quick-example" title="Link to this heading"></a></h2>
120108
<p>Here is a simple example showing how to send an email using python-o365.
@@ -154,6 +142,18 @@ <h2>Why choose O365?<a class="headerlink" href="#why-choose-o365" title="Link to
154142
<li><p>Etc. (see the code!)</p></li>
155143
</ul>
156144
</section>
145+
<section id="rebuilding-html-docs">
146+
<h2>Rebuilding HTML Docs<a class="headerlink" href="#rebuilding-html-docs" title="Link to this heading"></a></h2>
147+
<ul class="simple">
148+
<li><p>Install <code class="docutils literal notranslate"><span class="pre">sphinx</span></code> python library:</p></li>
149+
</ul>
150+
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">pip install sphinx</span>
151+
</pre></div>
152+
</div>
153+
<ul class="simple">
154+
<li><p>Run the shell script <code class="docutils literal notranslate"><span class="pre">build_docs.sh</span></code>, or copy the command from the file when using on Windows</p></li>
155+
</ul>
156+
</section>
157157
</section>
158158

159159

docs/latest/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)