Skip to content

Documentation update#237

Merged
jsmariegaard merged 15 commits intomainfrom
docs
Jul 6, 2023
Merged

Documentation update#237
jsmariegaard merged 15 commits intomainfrom
docs

Conversation

@ecomodeller
Copy link
Copy Markdown
Member

@ecomodeller ecomodeller commented Jun 30, 2023

  • Convert reStructuredText to markdown
  • Update content

@jsmariegaard
Copy link
Copy Markdown
Member

Fantastic 😍

@ecomodeller ecomodeller marked this pull request as ready for review June 30, 2023 14:43
@ecomodeller ecomodeller requested a review from jsmariegaard June 30, 2023 14:43
Copy link
Copy Markdown
Member

@jsmariegaard jsmariegaard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got a bunch of errors and warnings - and it doesn't render fully locally.

reading sources... [100%] vision
/workspaces/modelskill/docs/getting_started.md:28: ERROR: Unknown directive type ".python".
/workspaces/modelskill/docs/getting_started.md:48: ERROR: Unknown directive type ".python".
/workspaces/modelskill/docs/getting_started.md:63: ERROR: Unknown directive type ".python".
/workspaces/modelskill/docs/simple_compare.md:22: ERROR: Unknown directive type ".python".
/workspaces/modelskill/docs/simple_compare.md:32: ERROR: Unknown directive type ".python".
/workspaces/modelskill/docs/simple_compare.md:42: ERROR: Unknown directive type ".python".
/workspaces/modelskill/docs/simple_compare.md:53: ERROR: Unknown directive type ".python".
/workspaces/modelskill/docs/simple_compare.md:59: ERROR: Unknown directive type ".python".
/workspaces/modelskill/docs/simple_compare.md:65: ERROR: Unknown directive type ".python".
looking for now-outdated files... none found
pickling environment... done
checking consistency... /workspaces/modelskill/docs/api.rst: WARNING: document isn't included in any toctree
/workspaces/modelskill/docs/getting_started.md: WARNING: document isn't included in any toctree
/workspaces/modelskill/docs/simple_compare.md: WARNING: document isn't included in any toctree
/workspaces/modelskill/docs/vision.md: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] vision
/workspaces/modelskill/docs/getting_started.md:4: WARNING: 'myst' reference target not found: simple_compare.html
/workspaces/modelskill/docs/getting_started.md:22: WARNING: 'myst' reference target not found: api.html#modelskill.model.ModelResult
/workspaces/modelskill/docs/getting_started.md:42: WARNING: 'myst' reference target not found: api.html#modelskill.observation.PointObservation
/workspaces/modelskill/docs/getting_started.md:43: WARNING: 'myst' reference target not found: api.html#modelskill.observation.TrackObservation
/workspaces/modelskill/docs/getting_started.md:67: WARNING: 'myst' reference target not found: api.html#modelskill.comparison.ComparerCollection
/workspaces/modelskill/docs/getting_started.md:79: WARNING: 'myst' reference target not found: api.html#modelskill.comparison.ComparerCollection.skill
/workspaces/modelskill/docs/index.md:15: WARNING: 'myst' reference target not found: getting_started.html
/workspaces/modelskill/docs/simple_compare.md:4: WARNING: 'myst' reference target not found: getting_started.html
/workspaces/modelskill/docs/simple_compare.md:38: WARNING: 'myst' reference target not found: api.html#modelskill.connection.compare
/workspaces/modelskill/docs/simple_compare.md:49: WARNING: 'myst' reference target not found: api.html#modelskill.comparison.PointComparer

image

Copy link
Copy Markdown
Member

@jsmariegaard jsmariegaard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The GitHub action still reports some errors:

/home/runner/work/modelskill/modelskill/docs/getting-started.md:28: ERROR: Unknown directive type ".python".
/home/runner/work/modelskill/modelskill/docs/getting-started.md:48: ERROR: Unknown directive type ".python".
/home/runner/work/modelskill/modelskill/docs/getting-started.md:63: ERROR: Unknown directive type ".python".
/home/runner/work/modelskill/modelskill/docs/simple-compare.md:22: ERROR: Unknown directive type ".python".
/home/runner/work/modelskill/modelskill/docs/simple-compare.md:32: ERROR: Unknown directive type ".python".
/home/runner/work/modelskill/modelskill/docs/simple-compare.md:42: ERROR: Unknown directive type ".python".
/home/runner/work/modelskill/modelskill/docs/simple-compare.md:53: ERROR: Unknown directive type ".python".
/home/runner/work/modelskill/modelskill/docs/simple-compare.md:59: ERROR: Unknown directive type ".python".
/home/runner/work/modelskill/modelskill/docs/simple-compare.md:65: ERROR: Unknown directive type ".python".
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 20%] api
writing output... [ 40%] getting-started
writing output... [ 60%] index
writing output... [ 80%] simple-compare
writing output... [100%] vision
/home/runner/work/modelskill/modelskill/docs/getting-started.md:4: WARNING: 'myst' reference target not found: simple_compare.html

/home/runner/work/modelskill/modelskill/docs/getting-started.md:22: WARNING: 'myst' reference target not found: api.html#modelskill.model.ModelResult
/home/runner/work/modelskill/modelskill/docs/getting-started.md:42: WARNING: 'myst' reference target not found: api.html#modelskill.observation.PointObservation
/home/runner/work/modelskill/modelskill/docs/getting-started.md:43: WARNING: 'myst' reference target not found: api.html#modelskill.observation.TrackObservation
/home/runner/work/modelskill/modelskill/docs/getting-started.md:67: WARNING: 'myst' reference target not found: api.html#modelskill.comparison.ComparerCollection
/home/runner/work/modelskill/modelskill/docs/getting-started.md:79: WARNING: 'myst' reference target not found: api.html#modelskill.comparison.ComparerCollection.skill
/home/runner/work/modelskill/modelskill/docs/simple-compare.md:4: WARNING: 'myst' reference target not found: getting_started.html
/home/runner/work/modelskill/modelskill/docs/simple-compare.md:38: WARNING: 'myst' reference target not found: api.html#modelskill.connection.compare
/home/runner/work/modelskill/modelskill/docs/simple-compare.md:49: WARNING: 'myst' reference target not found: api.html#modelskill.comparison.PointComparer
generating indices... genindex py-modindex done

@jsmariegaard
Copy link
Copy Markdown
Member

My local version still includes some odd things:

image

Copy link
Copy Markdown
Member

@jsmariegaard jsmariegaard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All good - we will do more later

@jsmariegaard jsmariegaard merged commit 72534d4 into main Jul 6, 2023
@jsmariegaard jsmariegaard deleted the docs branch July 6, 2023 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants