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

Doc for initial release #14

Closed
51 of 52 tasks
prjemian opened this issue Jan 11, 2025 · 2 comments · Fixed by #49
Closed
51 of 52 tasks

Doc for initial release #14

prjemian opened this issue Jan 11, 2025 · 2 comments · Fixed by #49
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@prjemian
Copy link
Owner

prjemian commented Jan 11, 2025

Fill out the documentation sufficient for the initial release. Compare with the hklpy package.

hklpy documentation files:

  • ./_static/e4c-config.json
  • ./_static/e4c-config.yml
  • ./_static/issue-155.ipynb
  • ./api.rst
  • ./calc.rst
  • ./conf.py
  • ./configuration.rst
  • ./constraints.rst
  • ./context.rst
  • ./diffract.rst
  • ./diffract.rst (energy controls, including k4cve in geometries.rst)
  • ./engine.rst
  • ./examples/diffractometer.rst
  • ./examples/howto.rst
  • ./examples/notebooks/geo_e4cv.ipynb
  • ./examples/notebooks/geo_e6c.ipynb
  • ./examples/notebooks/geo_k4cv.ipynb
  • ./examples/notebooks/how_additional_parameters.ipynb
  • ./examples/notebooks/how_configuration.ipynb
  • ./examples/notebooks/how_extra_real_axis.ipynb
  • ./examples/notebooks/how_spec_commands.rst
  • ./examples/notebooks/README.md
  • ./examples/notebooks/resources/3S+1D.png
  • ./examples/notebooks/resources/4S+2D-labeled.png
  • ./examples/notebooks/resources/4S+2D-photo.jpg
  • ./examples/notebooks/resources/4S+2D.png
  • ./examples/notebooks/resources/6-circle-schematic.png
  • ./examples/notebooks/resources/img69.gif
  • ./examples/notebooks/resources/k4cv.png
  • ./examples/notebooks/resources/LNO_LAO_s14.dat
  • ./examples/notebooks/tst_e4cv_fourc.ipynb
  • ./examples/notebooks/tst_e6c_test_calculations.ipynb
  • ./examples/notebooks/tst_UB_in_descriptor_document.ipynb
  • ./examples/notebooks/tst_UB_in_stream.ipynb
  • ./examples/notebooks/var_e4cv_renamed_axes.ipynb
  • ./examples/notebooks/var_engines.ipynb
  • ./examples/notebooks/var_nslsii_tardis.ipynb
  • ./examples/t_and_c.rst
  • ./examples/variations.rst
  • ./geometries.rst
  • ./geometry_tables.rst
  • ./index.rst
  • ./install.rst
  • ./license.rst
  • ./overview.rst
  • ./ready_to_use.rst
  • ./release_notes.rst
  • ./sample.rst
  • ./substitutions.txt
  • ./user_guide.rst
  • ./user.rst
  • ./util.rst
@prjemian prjemian added the documentation Improvements or additions to documentation label Jan 11, 2025
@prjemian prjemian self-assigned this Jan 11, 2025
@prjemian prjemian added this to the v0.1.0 milestone Feb 9, 2025
@prjemian
Copy link
Owner Author

prjemian commented Mar 1, 2025

Consider Sphinx configuration that breaks each source code doc to its own page.

.. autosummary::
   :toctree: generated

prjemian added a commit that referenced this issue Mar 4, 2025
prjemian added a commit that referenced this issue Mar 4, 2025
prjemian added a commit that referenced this issue Mar 4, 2025
prjemian added a commit that referenced this issue Mar 4, 2025
@prjemian
Copy link
Owner Author

prjemian commented Mar 4, 2025

prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 10, 2025
prjemian added a commit that referenced this issue Mar 13, 2025
prjemian added a commit that referenced this issue Mar 13, 2025
prjemian added a commit that referenced this issue Mar 13, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 14, 2025
prjemian added a commit that referenced this issue Mar 15, 2025
prjemian added a commit that referenced this issue Mar 15, 2025
prjemian added a commit that referenced this issue Mar 15, 2025
prjemian added a commit that referenced this issue Mar 15, 2025
prjemian added a commit that referenced this issue Mar 15, 2025
prjemian added a commit that referenced this issue Mar 15, 2025
prjemian added a commit that referenced this issue Mar 16, 2025
prjemian added a commit that referenced this issue Mar 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant