Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tomicapretto committed Jan 19, 2025
1 parent 74b15f2 commit 8016d4e
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
pip install .
python --version
pip install mkdocs-material
pip install mkdocstrings
pip install mkdocstrings[python]
pip install pytkdocs[numpy-style]
cd docsite
mkdocs gh-deploy --force
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ docsite/docs/.ipynb_checkpoints
build/
README.ipynb

playground/
playground/
docsite/site/
2 changes: 1 addition & 1 deletion docsite/docs/usage/OOP.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Object-Oriented Interface

Flexitext provides the [`FlexiText()`](../../reference/FlexiText) class. This class is wrapped by the `flexitext()` function to provide the functional implementation. Unlike the functional implementation, this class based implementation does not work with formatted strings. It works with instances of the class `flexitext.Text`. These are lower level objects that contain both the text and the styles, given by an instance of `flexitext.Style`.
Flexitext provides the [`FlexiText()`](../reference/FlexiText.md) class. This class is wrapped by the `flexitext()` function to provide the functional implementation. Unlike the functional implementation, this class based implementation does not work with formatted strings. It works with instances of the class `flexitext.Text`. These are lower level objects that contain both the text and the styles, given by an instance of `flexitext.Style`.


## Setup
Expand Down
2 changes: 1 addition & 1 deletion docsite/docs/usage/functional.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Functional interface

Flexitext provides the `flexitext()` function. With the exception of the formatted strings, it works in the same way than the `.text()` method on Matplotlib's `Axes` objects. You can see its full documentation [here](../../reference/flexitext).
Flexitext provides the `flexitext()` function. With the exception of the formatted strings, it works in the same way than the `.text()` method on Matplotlib's `Axes` objects. You can see its full documentation [here](../reference/flexitext.md).

## Setup

Expand Down

0 comments on commit 8016d4e

Please sign in to comment.