Skip to content

Commit 19b7134

Browse files
committed
Improve module docs and README links
1 parent dfb0f80 commit 19b7134

File tree

4 files changed

+28
-11
lines changed

4 files changed

+28
-11
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,10 @@ See the [Quick Start guide](docs/quickstart.rst) for a step-by-step workflow.
4747

4848
Full documentation (quick start, recipes, developer guide, and API reference) lives under `docs/` and is published from the `gh-pages` branch:
4949

50-
- [Quick Start](docs/quickstart.rst)
51-
- [Guides](docs/guides/index.rst)
52-
- [API reference](docs/pandasaurus/index.rst)
50+
- [Hosted documentation](https://incatools.github.io/PandaSaurus/)
51+
- [Quick Start (source)](docs/quickstart.rst)
52+
- [Guides (source)](docs/guides/index.rst)
53+
- [API reference (source)](docs/pandasaurus/index.rst)
5354

5455
To build docs locally:
5556

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
Graph Generator
2-
==================
2+
===============
33

4-
Documentation
5-
-------------
4+
``GraphGenerator`` turns enrichment results into rdflib graphs and applies transitive reduction so you can visualize clean hierarchies.
5+
6+
Use it when:
7+
8+
* You need a graph representation of the enriched DataFrame (for plotting or exporting).
9+
* You want to remove redundant edges before exporting to visualization tools.
10+
11+
Class Reference
12+
---------------
613

714
.. currentmodule:: pandasaurus.graph.graph_generator
815

916
.. autoclass:: GraphGenerator
10-
:members:
17+
:members:

docs/pandasaurus/graph/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Graph Module
22
=======================
33

4+
Utilities for turning enrichment results into graphs and reducing redundancy before visualization.
5+
46
.. toctree::
57
:maxdepth: 2
68
:caption: Contents:

docs/pandasaurus/slim_manager.rst

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
Slim Manager
2-
==================
2+
============
33

4-
Documentation
5-
-------------
4+
Use :class:`pandasaurus.slim_manager.SlimManager` to explore ontology slims (subset tags) and retrieve the CURIEs they reference.
5+
6+
Typical scenarios:
7+
8+
* Enumerate slims available in an ontology via :meth:`~SlimManager.get_slim_list`.
9+
* Expand your seed list with all members of one or more slims via :meth:`~SlimManager.get_slim_members`.
10+
11+
Class Reference
12+
---------------
613

714
.. currentmodule:: pandasaurus.slim_manager
815

916
.. autoclass:: SlimManager
10-
:members:
17+
:members:

0 commit comments

Comments
 (0)