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

docs: overhaul #105

Merged
merged 13 commits into from
Sep 6, 2023
Merged

docs: overhaul #105

merged 13 commits into from
Sep 6, 2023

Conversation

mbelak-dtml
Copy link
Collaborator

@mbelak-dtml mbelak-dtml commented Aug 29, 2023

An overhaul of the documentation -- almost a complete re-write. Main differences:

  • Added quick-start examples and other examples
  • Added many internal and external links
  • Changed structure (notably getting started and advanced usage sections transformed into usage)

An overhaul of the documentation -- almost a complete re-write.
Main differences:
* Added quick-start examples and other examples
* Added many internal and external links
* Changed structure (notably *getting started* and *advanced usage* sections transformed into *usage*)
@mbelak-dtml
Copy link
Collaborator Author

mbelak-dtml commented Aug 29, 2023

To view the documentation:

  1. Install the environment poetry install
  2. Build API docs: poetry run sphinx-apidoc -o docs/source/ edvart/
  3. Build the HTML: poetry run make -C docs html
  4. Open docs/build/html/index.html in browser.

docs/index.rst Show resolved Hide resolved
docs/installation.rst Outdated Show resolved Hide resolved
docs/installation.rst Outdated Show resolved Hide resolved
docs/installation.rst Outdated Show resolved Hide resolved
docs/installation.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/sections.rst Outdated Show resolved Hide resolved
lukany
lukany previously approved these changes Sep 6, 2023
Copy link
Contributor

@lukany lukany left a comment

Choose a reason for hiding this comment

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

Approved with one optional suggestion.

docs/usage.rst Outdated Show resolved Hide resolved
@lukany lukany added this pull request to the merge queue Sep 6, 2023
Merged via the queue into main with commit 00da056 Sep 6, 2023
5 checks passed
@lukany lukany deleted the docs/overhaul branch September 6, 2023 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants