Spaces:
Sleeping
Sleeping
Commit
•
a8a0333
1
Parent(s):
42ef7d9
Build api documentation with pydoc-markdown
Browse files- docs/_sidebar.md +5 -1
- pydoc-markdown.yml +69 -0
docs/_sidebar.md
CHANGED
|
@@ -3,4 +3,8 @@
|
|
| 3 |
- [Getting Started](/)
|
| 4 |
- [Options](options.md)
|
| 5 |
- [Operators](operators.md)
|
| 6 |
-
- [Examples](examples.md)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
- [Getting Started](/)
|
| 4 |
- [Options](options.md)
|
| 5 |
- [Operators](operators.md)
|
| 6 |
+
- [Examples](examples.md)
|
| 7 |
+
|
| 8 |
+
- API Reference
|
| 9 |
+
|
| 10 |
+
- [PySRRegressor](api.md)
|
pydoc-markdown.yml
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#@ def base_url():
|
| 2 |
+
#@ if env.READTHEDOCS:
|
| 3 |
+
#@ return "https://pysr.readthedocs.io/en/" + env.READTHEDOCS_VERSION + "/"
|
| 4 |
+
#@ else:
|
| 5 |
+
#@ return None
|
| 6 |
+
#@ end
|
| 7 |
+
|
| 8 |
+
|
| 9 |
+
loaders:
|
| 10 |
+
- type: python
|
| 11 |
+
|
| 12 |
+
processors:
|
| 13 |
+
- type: filter
|
| 14 |
+
- type: smart
|
| 15 |
+
- type: crossref
|
| 16 |
+
renderer:
|
| 17 |
+
type: hugo
|
| 18 |
+
|
| 19 |
+
markdown:
|
| 20 |
+
source_linker:
|
| 21 |
+
type: github
|
| 22 |
+
repo: MilesCranmer/PySR
|
| 23 |
+
|
| 24 |
+
config:
|
| 25 |
+
baseURL: #@ base_url()
|
| 26 |
+
title: PySR
|
| 27 |
+
theme: {clone_url: "https://github.com/alex-shpak/hugo-book.git"}
|
| 28 |
+
# The "book" theme only renders pages in "content/docs" into the nav.
|
| 29 |
+
|
| 30 |
+
build_directory: docs/build
|
| 31 |
+
content_directory: content/docs
|
| 32 |
+
|
| 33 |
+
default_preamble: {menu: main}
|
| 34 |
+
pages:
|
| 35 |
+
- title: Home
|
| 36 |
+
name: index
|
| 37 |
+
source: README.md
|
| 38 |
+
directory: '..'
|
| 39 |
+
- title: Getting started
|
| 40 |
+
name: getting-started
|
| 41 |
+
source: docs/start.md
|
| 42 |
+
preamble: {weight: 1}
|
| 43 |
+
- title: Features and Options
|
| 44 |
+
name: options
|
| 45 |
+
source: docs/options.md
|
| 46 |
+
preamble: {weight: 2}
|
| 47 |
+
- title: Operators
|
| 48 |
+
name: operators
|
| 49 |
+
source: docs/operators.md
|
| 50 |
+
preamble: {weight: 3}
|
| 51 |
+
- title: Examples
|
| 52 |
+
name: examples
|
| 53 |
+
source: docs/examples.md
|
| 54 |
+
preamble: {weight: 4}
|
| 55 |
+
- title: API
|
| 56 |
+
contents:
|
| 57 |
+
- pysr.sr.install
|
| 58 |
+
- pysr.sr.PySRRegressor.__init__
|
| 59 |
+
- pysr.sr.PySRRegressor.fit
|
| 60 |
+
- pysr.sr.PySRRegressor.predict
|
| 61 |
+
- pysr.sr.PySRRegressor.__repr__
|
| 62 |
+
- pysr.sr.PySRRegressor.set_params
|
| 63 |
+
- pysr.sr.PySRRegressor.get_params
|
| 64 |
+
- pysr.sr.PySRRegressor.get_best
|
| 65 |
+
- pysr.sr.PySRRegressor.sympy
|
| 66 |
+
- pysr.sr.PySRRegressor.latex
|
| 67 |
+
- pysr.sr.PySRRegressor.jax
|
| 68 |
+
- pysr.sr.PySRRegressor.pytorch
|
| 69 |
+
- pysr.sr.PySRRegressor.refresh
|