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

Make documentation available for Python API #345

Merged
merged 1 commit into from
Feb 23, 2024
Merged

Make documentation available for Python API #345

merged 1 commit into from
Feb 23, 2024

Conversation

mgeplf
Copy link
Contributor

@mgeplf mgeplf commented Feb 1, 2024

  • CircuitConfig, NodeSets, and SimulationConfig didn't have a top level docstring and thus sphinx automodule wasn't displaying them

braynscircuitstudio/fake-backend/src/api_sonata_list_populations.py?r=01bd1007809656a55239de478601cb1ac4adfc16
libsonata._libsonata.Report.Type

BlueBrain/BlueCelluLab/bluecellulab/circuit/config/sections.py?r=dbe824ac754fe878a37acf99b57d6ed968045106
from libsonata._libsonata import Conditions as LibSonataConditions

  • SNAP tests have been updated to handle the different versions

mgeplf added a commit to BlueBrain/snap that referenced this pull request Feb 1, 2024
mgeplf added a commit to BlueBrain/snap that referenced this pull request Feb 6, 2024
* work around libsonata refactor
* see BlueBrain/libsonata#345
* CircuitConfig, NodeSets, and SimulationConfig didn't have a top level
  docstring and thus sphinx `automodule` wasn't displaying them

* Many of the SimulationConfig were rooted in _libsonata, when they
  should be in SimulationConfig; this was refactored, however it has
  implications in the following projects:

* BlueCelluLab was update to work around the change
    BlueBrain/BlueCelluLab#123

* SNAP tests have been updated to handle the different locations of
  SimulationConfig classes:
    BlueBrain/snap#254
@mgeplf
Copy link
Contributor Author

mgeplf commented Feb 15, 2024

I'm going to wait to merge this until @WeinaJi has a chance to look.

Copy link
Collaborator

@WeinaJi WeinaJi left a comment

Choose a reason for hiding this comment

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

Looks all good. Thank you for the improvements.

@mgeplf mgeplf merged commit 0f7b4e4 into master Feb 23, 2024
24 checks passed
@mgeplf mgeplf deleted the fix-docs branch February 23, 2024 08:14
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.

4 participants