Skip to content

Commit 1ac7c08

Browse files
mrm9084mrm9084
committed
Updating docs
1 parent c29e642 commit 1ac7c08

11 files changed

Lines changed: 410 additions & 243 deletions

‎README.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Feature Management is a library for enabling/disabling features at runtime. Deve
1313
Install the Python feature management client library for Python with [pip][pip]:
1414

1515
```bash
16-
pip install microsoft-featuremanagement
16+
pip install featuremanagement
1717
```
1818

1919
## Usage
@@ -30,10 +30,7 @@ import os
3030

3131
endpoint = os.environ.get("APPCONFIGURATION_ENDPOINT_STRING")
3232

33-
# If no setting selector is set then feature flags with no label are loaded.
34-
selects = {SettingSelector(key_filter=".appconfig.featureflag*")}
35-
36-
config = load(endpoint=endpoint, credential=DefaultAzureCredential(), selects=selects)
33+
config = load(endpoint=endpoint, credential=DefaultAzureCredential(), feature_flag_enabled=True, feature_flag_refresh_enabled=True)
3734

3835
feature_manager = FeatureManager(config)
3936

@@ -291,3 +288,5 @@ trademarks or logos is subject to and must follow
291288
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
292289
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
293290
Any use of third-party trademarks or logos are subject to those third-party's policies.
291+
292+
[pip]: https://pypi.org/project/FeatureManagement/

‎docs/html/_sources/featuremanagement.rst.txt‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Subpackages
2+
-----------
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
featuremanagement.aio
8+
9+
Module contents
10+
---------------
11+
12+
.. automodule:: featuremanagement
13+
:members:
14+
:undoc-members:

‎docs/html/_sources/index.rst.txt‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,4 @@ Subpackages
77
.. toctree::
88
:maxdepth: 4
99

10-
featuremanagement.aio
11-
12-
Module contents
13-
---------------
14-
15-
.. automodule:: featuremanagement
16-
:members:
17-
:undoc-members:
10+
featuremanagement

‎docs/html/featuremanagement.aio.html‎

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<script src="_static/js/theme.js"></script>
2020
<link rel="index" title="Index" href="genindex.html" />
2121
<link rel="search" title="Search" href="search.html" />
22-
<link rel="prev" title="Microsoft Feature Management for Python" href="index.html" />
22+
<link rel="prev" title="Subpackages" href="featuremanagement.html" />
2323
</head>
2424

2525
<body class="wy-body-for-nav">
@@ -42,31 +42,20 @@
4242
</div>
4343
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4444
<ul class="current">
45-
<li class="toctree-l1 current"><a class="current reference internal" href="#">featuremanagement.aio package</a><ul>
46-
<li class="toctree-l2"><a class="reference internal" href="#module-featuremanagement.aio">Module contents</a><ul>
47-
<li class="toctree-l3"><a class="reference internal" href="#featuremanagement.aio.FeatureFilter"><code class="docutils literal notranslate"><span class="pre">FeatureFilter</span></code></a><ul>
48-
<li class="toctree-l4"><a class="reference internal" href="#featuremanagement.aio.FeatureFilter.alias"><code class="docutils literal notranslate"><span class="pre">FeatureFilter.alias()</span></code></a></li>
49-
<li class="toctree-l4"><a class="reference internal" href="#featuremanagement.aio.FeatureFilter.evaluate"><code class="docutils literal notranslate"><span class="pre">FeatureFilter.evaluate()</span></code></a></li>
50-
<li class="toctree-l4"><a class="reference internal" href="#featuremanagement.aio.FeatureFilter.name"><code class="docutils literal notranslate"><span class="pre">FeatureFilter.name</span></code></a></li>
51-
</ul>
52-
</li>
53-
<li class="toctree-l3"><a class="reference internal" href="#featuremanagement.aio.FeatureManager"><code class="docutils literal notranslate"><span class="pre">FeatureManager</span></code></a><ul>
54-
<li class="toctree-l4"><a class="reference internal" href="#featuremanagement.aio.FeatureManager.is_enabled"><code class="docutils literal notranslate"><span class="pre">FeatureManager.is_enabled()</span></code></a></li>
55-
<li class="toctree-l4"><a class="reference internal" href="#featuremanagement.aio.FeatureManager.list_feature_flag_names"><code class="docutils literal notranslate"><span class="pre">FeatureManager.list_feature_flag_names()</span></code></a></li>
56-
</ul>
57-
</li>
58-
<li class="toctree-l3"><a class="reference internal" href="#featuremanagement.aio.TargetingFilter"><code class="docutils literal notranslate"><span class="pre">TargetingFilter</span></code></a><ul>
59-
<li class="toctree-l4"><a class="reference internal" href="#featuremanagement.aio.TargetingFilter.evaluate"><code class="docutils literal notranslate"><span class="pre">TargetingFilter.evaluate()</span></code></a></li>
60-
</ul>
61-
</li>
62-
<li class="toctree-l3"><a class="reference internal" href="#featuremanagement.aio.TimeWindowFilter"><code class="docutils literal notranslate"><span class="pre">TimeWindowFilter</span></code></a><ul>
63-
<li class="toctree-l4"><a class="reference internal" href="#featuremanagement.aio.TimeWindowFilter.evaluate"><code class="docutils literal notranslate"><span class="pre">TimeWindowFilter.evaluate()</span></code></a></li>
45+
<li class="toctree-l1 current"><a class="reference internal" href="featuremanagement.html">Subpackages</a><ul class="current">
46+
<li class="toctree-l2 current"><a class="current reference internal" href="#">featuremanagement.aio package</a><ul>
47+
<li class="toctree-l3"><a class="reference internal" href="#module-featuremanagement.aio">Module contents</a><ul>
48+
<li class="toctree-l4"><a class="reference internal" href="#featuremanagement.aio.FeatureFilter"><code class="docutils literal notranslate"><span class="pre">FeatureFilter</span></code></a></li>
49+
<li class="toctree-l4"><a class="reference internal" href="#featuremanagement.aio.FeatureManager"><code class="docutils literal notranslate"><span class="pre">FeatureManager</span></code></a></li>
50+
<li class="toctree-l4"><a class="reference internal" href="#featuremanagement.aio.TargetingFilter"><code class="docutils literal notranslate"><span class="pre">TargetingFilter</span></code></a></li>
51+
<li class="toctree-l4"><a class="reference internal" href="#featuremanagement.aio.TimeWindowFilter"><code class="docutils literal notranslate"><span class="pre">TimeWindowFilter</span></code></a></li>
6452
</ul>
6553
</li>
6654
</ul>
6755
</li>
6856
</ul>
6957
</li>
58+
<li class="toctree-l1"><a class="reference internal" href="featuremanagement.html#module-featuremanagement">Module contents</a></li>
7059
</ul>
7160

7261
</div>
@@ -83,6 +72,7 @@
8372
<div role="navigation" aria-label="Page navigation">
8473
<ul class="wy-breadcrumbs">
8574
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
75+
<li class="breadcrumb-item"><a href="featuremanagement.html">Subpackages</a></li>
8676
<li class="breadcrumb-item active">featuremanagement.aio package</li>
8777
<li class="wy-breadcrumbs-aside">
8878
<a href="_sources/featuremanagement.aio.rst.txt" rel="nofollow"> View page source</a>
@@ -239,7 +229,7 @@ <h1>featuremanagement.aio package<a class="headerlink" href="#featuremanagement-
239229
</div>
240230
</div>
241231
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
242-
<a href="index.html" class="btn btn-neutral float-left" title="Microsoft Feature Management for Python" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
232+
<a href="featuremanagement.html" class="btn btn-neutral float-left" title="Subpackages" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
243233
</div>
244234

245235
<hr/>

0 commit comments

Comments
 (0)