GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Add sphinx doc by KybernetikJo · Pull Request #202 · python-control/Slycot

Conversation

@KybernetikJo

@KybernetikJo KybernetikJo commented Jul 26, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

This PR adds a sphinx documentation. The doc includes an introduction, API reference, developer info and examples.

  • Introduction
  • API reference
    • autodoc slycot.<>
    • autodoc slycot._wrapper.<>
    • SLICOT help as link
  • Developer Guide / Contribution Guide
    • github slycot, pull request
    • Guide to create a wrapper, f2py, .pyf, numpydoc (not sure how detailed it will be)
  • Examples
    • Python scripts (some example)
    • Python scripts (more or better Examples, maybe)
    • Jupyter notebooks
    • Jupyter notebooks (more or better Examples, maybe)
  • "Slycot Analyzer"
    • inspect slicot fortran.f files
    • inspect slicot help files
    • inspect slycot routines
    • inspect slycot._wrapper rountines
    • compare slycot implemented rountines with hellp
  • Github Action
    • check all added rountines are included in the sphinx doc (as suggested by @bnavigator )

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@KybernetikJo KybernetikJo mentioned this pull request Aug 8, 2023
Defining Roadmap to Slycot 0.7.0 #204
Closed
10 tasks done
@KybernetikJo
KybernetikJo marked this pull request as ready for review August 17, 2023 19:49
@KybernetikJo

KybernetikJo commented Aug 17, 2023

Copy link
Copy Markdown
Contributor Author

From my point of view, this version would be ready for merging.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@KybernetikJo
KybernetikJo force-pushed the add_sphinx_doc branch from 1dd6c66 to 26fd2b0 Compare August 23, 2023 19:08
bnavigator
bnavigator reviewed Aug 24, 2023
View reviewed changes
Comment thread doc/conf.py Outdated
Comment on lines +13 to +16
project = 'Slycot'
copyright = '2023, Slycot Developers'
author = 'Slycot Developers'
release = '0.6'

@bnavigator bnavigator Aug 24, 2023

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Can this be automated to look at the git tag?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@KybernetikJo KybernetikJo Aug 24, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I could use the code from python-control. Would that be enough?

# Version information - read from the source code
import re

# Get the version number for this commmit (including alpha/beta/rc tags)
release = re.sub('^v', '', os.popen('git describe').read().strip())

# The short X.Y.Z version
version = re.sub(r'(\d+\.\d+\.\d+(.post\d+)?)(.*)', r'\1', release)

print("version %s, release %s" % (version, release))

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
bnavigator reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
bnavigator
bnavigator reviewed Aug 24, 2023
View reviewed changes
Comment thread doc/source/reference/slycot_outer.rst
.. autosummary::
:toctree: generated/

ab01nd

@bnavigator bnavigator Aug 24, 2023

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

So wee need to add entries here for every additional wrapper? Better write a check that we don't forget anything.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@KybernetikJo KybernetikJo Aug 24, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Good point. I also thought about that.

There is a python script /doc/create_names_for_reference.py that generates all routine names of
slycot and slycot._wrapper.

I think there are 2 options:

  1. a script that compares the output from the script above with the routine names found in slycot_outer.rst and slycot_inner.rst.
  2. a script that generates the whole files of slycot_outer.rst and slycot_inner.rst.

I have to look into that.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
bnavigator reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@KybernetikJo
KybernetikJo force-pushed the add_sphinx_doc branch from 26fd2b0 to 0e79a27 Compare August 25, 2023 18:23
@bnavigator bnavigator added this to the 0.6.0 milestone Aug 26, 2023
@KybernetikJo
KybernetikJo force-pushed the add_sphinx_doc branch from c327620 to fb26217 Compare August 26, 2023 14:08
@bnavigator

bnavigator commented Aug 26, 2023

Copy link
Copy Markdown
Collaborator

Do we need a sphinx workflow in the .github actions in order to check results?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@KybernetikJo

KybernetikJo commented Aug 26, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

Do we need a sphinx workflow in the .github actions in order to check results?

To be honest, I don't have much experience with github actions and don't know what is possible.

Currently I'm thinking about some kind of slycot-analyzer that analyzes the slycot and slicot-reference modules, generates statistics and checks for some completeness.

I would put this "slycot-analyzer" under slycot/doc/slycot-analyzer.

github actions could call some functions of a "slycot-analyzer".

Currently there are some python/notebook files:

  • doc/check_names.py
  • doc/create_names_for_reference.py
  • doc/source/dev/inspect_slycot.ipynb
  • doc/source/dev/inspect_slicot_slycot.ipynb

For now, though, I'll focus on the docstring and numpydocs.
bnavigator reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@KybernetikJo
KybernetikJo force-pushed the add_sphinx_doc branch from 4b2dc1e to 396f287 Compare January 9, 2024 22:46
@bnavigator bnavigator modified the milestones: 0.6.0, 0.7 Jan 28, 2024
@bnavigator bnavigator mentioned this pull request Feb 11, 2024
Observability Gramian for discrete-time systems python-control/python-control#967
Closed
@KybernetikJo
KybernetikJo force-pushed the add_sphinx_doc branch from e903744 to 9815526 Compare April 4, 2024 17:55
KybernetikJo added 14 commits April 6, 2024 14:48
@KybernetikJo
DOC: Add sphinx doc, initial commit
a99afe1
@KybernetikJo
DOC: Add examples
d0a0d2d
@KybernetikJo
Update gitignore
224221e
@KybernetikJo
DOC: Add slicot and slycot inspection
c764077
@KybernetikJo
Update inspection notebooks
4045036
@KybernetikJo
Update development info
8427bc0
@KybernetikJo
Improve inspection notebooks, Minor update of docs
0727127
@KybernetikJo
Remove SLICOT help html files from _static, add link to online SLICOT…
a4d302b 
… help
@KybernetikJo
Update outer and inner function reference
0450153
@KybernetikJo
Update inpect_notebooks, Update create names for Slycot reference.
90e328f
@KybernetikJo
Update inpection notebooks
d7f56e6
@KybernetikJo
Add code to get info of release and version from git tags
61ed3d2
@KybernetikJo
Update doc/source to add new routines
501e5e5
@KybernetikJo
Add check_names, checks if all routines are added in sphinx help
6e67460
KybernetikJo added 9 commits April 6, 2024 14:48
@KybernetikJo
Add ag08bd, add sb10yd to help
b6b4579
@KybernetikJo
Add new routines to sphinx doc
62696c4
@KybernetikJo
Pump sphinx doc requirements
c542a90
@KybernetikJo
Update slycot inpect notebooks
ec834fc
@KybernetikJo
Automate update of year in copyright
c08b251
@KybernetikJo
Change doc organization to diataxis approach
7bd444d
@KybernetikJo
Add sphinx-copybutton
d850266
@KybernetikJo
Update venn diagramm in inpect notebooks
e5765c7
@KybernetikJo
Update ho-to-guides examples
9b6b178
@KybernetikJo
KybernetikJo force-pushed the add_sphinx_doc branch from 9815526 to 9b6b178 Compare April 6, 2024 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bnavigator bnavigator bnavigator left review comments

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

0.7

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@KybernetikJo @bnavigator
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.