Skip to content

Commit 04c254e

Browse files
committed
Added docs for greedy algorithms
1 parent 797f654 commit 04c254e

File tree

3 files changed

+81
-3
lines changed

3 files changed

+81
-3
lines changed

docs/Greedy.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
=================
2+
Greedy Algorithms
3+
=================
4+
5+
A place for implementation of greedy algorithms
6+
7+
Features
8+
--------
9+
10+
* To see all the available functions in a module, you can just type ``help()`` with the module name as argument. For example,
11+
12+
.. code:: python
13+
14+
>>> from pygorithm import greedy_algorithm
15+
>>> help(greedy_algorithm)
16+
Help on package pygorithm.greedy_algorithm in pygorithm:
17+
18+
NAME
19+
pygorithm.greedy_algorithm - Collection for greedy algorithms
20+
21+
PACKAGE CONTENTS
22+
activity_selection
23+
fractional_knapsack
24+
25+
DATA
26+
__all__ = ['fractional_knapsack', 'activity_selection']
27+
28+
29+
Activity Selection Problem
30+
--------------------------
31+
32+
* Functions and their uses
33+
34+
.. automodule:: pygorithm.greedy_algorithm.activity_selection
35+
:members:
36+
37+
Fractional Knapsack
38+
-------------------
39+
40+
* Functions and their uses
41+
42+
.. automodule:: pygorithm.greedy_algorithm.fractional_knapsack
43+
:members:

docs/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,17 @@ Quick Links
2222
:maxdepth: 2
2323
:caption: Documentation:
2424

25-
Sorting
26-
Searching
2725
Data_Structure
26+
DynamicP
2827
Fibonacci
28+
Greedy
2929
Math
3030
Pathfinding
31+
Searching
32+
Sorting
3133
strings
3234

35+
3336
Quick Start Guide
3437
-----------------
3538

docs/strings.rst

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,41 @@ Features
2727
2828
2929
Anagram
30-
-----------
30+
-------
3131

3232
* Functions and their uses
3333

3434
.. automodule:: pygorithm.strings.anagram
3535
:members:
36+
37+
Isogram
38+
-------
39+
40+
* Functions and their uses
41+
42+
.. automodule:: pygorithm.strings.isogram
43+
:members:
44+
45+
Palindrome
46+
----------
47+
48+
* Functions and their uses
49+
50+
.. automodule:: pygorithm.strings.palindrome
51+
:members:
52+
53+
Pangram
54+
-------
55+
56+
* Functions and their uses
57+
58+
.. automodule:: pygorithm.strings.pangram
59+
:members:
60+
61+
Manacher's Algorithm
62+
--------------------
63+
64+
* Functions and their uses
65+
66+
.. automodule:: pygorithm.strings.manacher_algorithm
67+
:members:

0 commit comments

Comments
 (0)