Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolve markdown linter errors #54

Merged
merged 1 commit into from
Feb 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

### From PyPI

**In development**
#### *pypi support in development*

<!-- ```
conda create --name test python=3.8
conda activate test
Expand All @@ -16,7 +17,7 @@ pip install GOSTnets

### From `conda-forge`

**In development**
#### *conda support in development*

### From Source

Expand Down Expand Up @@ -116,13 +117,13 @@ Plenty of examples and tutorials using Jupyter Notebooks live inside of the Impl

in the docs dir, run:

```
```shell
sphinx-apidoc -f -o source/ ../GOSTnets
```

in the docs dir, run:

```
```shell
make html
```

Expand All @@ -137,7 +138,7 @@ gn.edge_gdf_from_graph?

returns:

```
```python
Signature: gn.edge_gdf_from_graph(G, crs={'init': 'epsg:4326'}, attr_list=None, geometry_tag='geometry', xCol='x', yCol='y')
#### Function for generating a GeoDataFrame from a networkx Graph object ###
REQUIRED: a graph object G
Expand Down
2 changes: 2 additions & 0 deletions Tutorials/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Tutorial

These notebooks are designed to introduce the methodology of GOSTNets to novice python users; in order to properly implement these, users should have a basic knowledge of

- Python
- Jupyter notebooks
- Anaconda (for setup)
Expand Down
Loading