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.

Sign up for GitHub

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

Jump to bottom

Use Sphinx docs with ReadTheDocs #100

Merged
merged 42 commits into from
Feb 9, 2021
Merged

Use Sphinx docs with ReadTheDocs #100

merged 42 commits into from
Feb 9, 2021

Conversation

astrochun
Copy link
Owner

See issue #99

  • sphinx-quickstart initialization
  • Add API documentation
  • Type hinting and update docstrings for analysis.attenuation module
  • Type hinting and update docstrings for analysis.error_prop module
  • Type hinting and update docstrings for analysis.fitting module
  • Type hinting and update docstrings for analysis.ratios module

@astrochun astrochun added this to the v1.4.0 milestone Feb 7, 2021
@astrochun astrochun added CI/CD documentation Improvements or additions to documentation enhancement New feature or request labels Feb 7, 2021
@astrochun astrochun self-assigned this Feb 7, 2021
@astrochun
Type hinting and update docstrings for analysis.temp_metallicity_calc…
bf856d6 
… module
@astrochun
Type hinting and update docstrings for analysis.composite_indv_detect…
da7b9bb 
… module
@astrochun
Type hinting and update docstrings for MSC __init__ module
a7b21d9
@astrochun
Fix bug with log input (CI build fail)
69b6f09
@astrochun
Type hinting and update docstrings for column_names module
30d5c2e
@astrochun
Type hinting and update docstrings for logging module
ca14b04
@astrochun
Type hinting and update docstrings for valid_table module
894e054
@astrochun
Fix too short title underline
5930269
@astrochun
Fix sphinx compile issues for analysis.temp_metallicity_calc module
5924118
@astrochun
Fix sphinx error message in composite_indv_detect module
b760b99 
 - WARNING: Inline emphasis start-string without end-string.
@astrochun
Add plotting subpackage docs
e676f85 
 - Type hinting and update docstrings for plotting.balmer module
@astrochun
Add sphinx-build GitHub Actions
25e1abf
@astrochun
Adjust :return description in analysis.attenuation module
2feb19d 
 - Minor PEP8 whitespace fixes
@astrochun
Adjust :return: descriptions in analysis.fitting module
9a3943c
@astrochun
Adjust :return: description in analysis.ratios module
129cceb
@astrochun
Adjust :return: descriptions in analysis.temp_metallicity_calc module
18bae61
@astrochun
Adjust/add :return: descriptions in column_names module
425a5c5
@astrochun
Adjust top-level docstrings for plotting.balmer module
49e0693
@astrochun
Type hinting and update docstrings for update_det4363_info module
3f4f0ac
@astrochun
Adjust :return: descriptions in __init__ module
2938cf1
@astrochun
Type hinting and update docstrings for attenuation.compute_EBV for di…
ce5c8c5 
…fferent returns
@astrochun
Fix type hinting for attenuation.compute_EBV
306a922
@astrochun
Adjust type hinting and docstrings for log inputs
fc5ddd1 
 - analysis.attenuation
 - analysis.composite_indv_detect
 - analysis.error_prop
 - analysis.fitting
 - analysis.ratios
 - analysis.temp_metallicity_calc
 - plotting.balmer
 - logging
 - update_det4363_info
@astrochun
extract_deep2_data: Adjust type hinting and docstrings for log inputs
67d40d2 
 - Switch log default
@astrochun
Update sphinx-build GitHub actions to include chun_codes
c947b13
@astrochun
Use develop option for build of chun_codes in sphinx-build GitHub Act…
9c660d6 
…ions
@astrochun
Use setup-python action in sphinx-build
f7ab962 
 - Specify python-version
@astrochun
Use actions-checkout for MSC
ef44398
@astrochun
Update README for GitHub badges for GitHub Action status
fe4b431
@astrochun
Fix typo: main -> master branch
995ca9d
@astrochun
Update GitHub badges in intro.rst
cb59f00
@astrochun
Adjust type hinting and docstrings for __init__
eab1a41
@astrochun
Adjust type hinting in error_prop
0df743b
astrochun
astrochun commented Feb 9, 2021
View reviewed changes
Copy link
Owner Author

@astrochun astrochun left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Minor change. Looks good.

Need to:

  • Check for if log is None handling

docs/source/conf.py Outdated Show resolved Hide resolved
astrochun
astrochun commented Feb 9, 2021
View reviewed changes
Copy link
Owner Author

@astrochun astrochun left a comment

Choose a reason for hiding this comment

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

All minor changes seem to be addressed

@astrochun astrochun merged commit 30e03d1 into develop Feb 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@astrochun astrochun

Labels
CI/CD documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
v1.4.0
Development

Successfully merging this pull request may close these issues.
1 participant
@astrochun