search

simphony / docs

Documentation of the SimPhoNy Open Simulation Platform.
https://simphony.readthedocs.io
BSD 3-Clause "New" or "Revised" License
3 stars 4 forks source link

Docs for how to query a namespace #154

Closed create-issue-branch[bot] closed 3 years ago

create-issue-branch[bot] commented 3 years ago

closes #148

kysrpex commented 3 years ago

I get the following error message in the console:

[sphinx-autobuild] > sphinx-build /app/docs/source /app/docs/build/html
Running Sphinx v3.5.3
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 24 source files that are out of date
updating environment: [new config] 24 added, 0 changed, 0 removed
/usr/local/lib/python3.8/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document                                                                                
  warn("Container node skipped: type={0}".format(mdnode.t))
/usr/local/lib/python3.8/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document                                                                                
  warn("Container node skipped: type={0}".format(mdnode.t))
/usr/local/lib/python3.8/site-packages/osp/core/cuds.py:docstring of osp.core.cuds.Cuds.get:7: WARNING: Unexpected indentation.                                                                     
/usr/local/lib/python3.8/site-packages/osp/core/cuds.py:docstring of osp.core.cuds.Cuds.get:3: WARNING: Inline emphasis start-string without end-string.
/usr/local/lib/python3.8/site-packages/osp/core/cuds.py:docstring of osp.core.cuds.Cuds.get:3: WARNING: Inline emphasis start-string without end-string.
/usr/local/lib/python3.8/site-packages/osp/core/cuds.py:docstring of osp.core.cuds.Cuds.get:13: WARNING: Block quote ends without a blank line; unexpected unindent.
/usr/local/lib/python3.8/site-packages/osp/core/cuds.py:docstring of osp.core.cuds.Cuds.iter:8: WARNING: Unexpected indentation.
/usr/local/lib/python3.8/site-packages/osp/core/cuds.py:docstring of osp.core.cuds.Cuds.iter:5: WARNING: Inline emphasis start-string without end-string.
/usr/local/lib/python3.8/site-packages/osp/core/cuds.py:docstring of osp.core.cuds.Cuds.iter:5: WARNING: Inline emphasis start-string without end-string.
/usr/local/lib/python3.8/site-packages/osp/core/cuds.py:docstring of osp.core.cuds.Cuds.iter:12: WARNING: Block quote ends without a blank line; unexpected unindent.
/usr/local/lib/python3.8/site-packages/osp/core/cuds.py:docstring of osp.core.cuds.Cuds.remove:3: WARNING: Inline emphasis start-string without end-string.
/usr/local/lib/python3.8/site-packages/osp/core/cuds.py:docstring of osp.core.cuds.Cuds.remove:3: WARNING: Inline emphasis start-string without end-string.
/usr/local/lib/python3.8/site-packages/osp/core/utils/wrapper_development.py:docstring of osp.core.utils.wrapper_development.get_neighbor_diff:10: WARNING: Unexpected indentation.
/usr/local/lib/python3.8/site-packages/osp/core/utils/wrapper_development.py:docstring of osp.core.utils.wrapper_development.get_neighbor_diff:11: WARNING: Block quote ends without a blank line; unexpected unindent.
/app/docs/source/detailed_design.md:149: WARNING: duplicate label cuds, other instance in /app/docs/source/api_ref.md
/app/docs/source/detailed_design.md:401: WARNING: duplicate label registry, other instance in /app/docs/source/api_ref.md
/app/docs/source/fundamentals.md:137: WARNING: duplicate label cuds, other instance in /app/docs/source/detailed_design.md
/app/docs/source/general_architecture.md:204: WARNING: duplicate label sessions, other instance in /app/docs/source/api_ref.md

Notebook error:
UndefinedError in jupyter/cuds_api.ipynb:
'nbformat.notebooknode.NotebookNode object' has no attribute 'tags'
Command exited with exit code: 2
The server will continue serving the build folder, but the contents being served are no longer in sync with the documentation sources. Please fix the cause of the error above or press Ctrl+C to stop the server.

The changes are also not visible in the browser

@yoavnash It fails due to #156 being merged into dev but not into this branch. I just merged dev into this branch. Note that you'll need to rebuild the docker image.

kysrpex commented 3 years ago

@kysrpex Another comment is concerning the functions get_custom_datatypes and get_custom_datatype_triples. Shouldn't they be includes as well?

Personally I would not. At a first glance I do not see why a novice would be interested in this. I think it is fine just having them in the API reference as it is the case now, for advanced users.