Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
avgcampos committed Apr 1, 2024
1 parent afb263d commit 11d0681
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,15 @@ The following python packages are required to run myfempy. Before to install myf

A **Basic Tutorial** is available [here]().

Many **Examples** are available [here]().
Many **Examples** are available [here](https://github.com/avgcampos/myfempy/tree/main/examples).

## Documentation

The myfempy is documented using Mkdocs under `docs/`. The myfempy's documents versions can be found in html, pdf or epub.

The **Web Documentation** is available on [Read the Docs](https://myfempy.readthedocs.io/).

The **User's Manual**(pdf) is available on [manual_myfempy](https://github.com/easycae-3d/myfempy/blob/main/doc/manual%20myfempy.pdf).
The **User's Manual**(pdf) is available on [manual_myfempy](https://myfempy.readthedocs.io/en/latest/user_guide/).

To compile the documentation use *sphinx* in the **\doc** folder. Do,

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ nav:
- Contribution: about.md
- User Guide: user_guide.md
- Theory: theory.md
- Examples: examples.md
- History: history.md
- Tutorial: tutorial.md
- Deployment: history.md
theme:
name: readthedocs
logo: assets/logo.png
Expand Down

0 comments on commit 11d0681

Please sign in to comment.