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

Documentation fixes and additions - installation related #1567

Merged
merged 4 commits into from
Mar 29, 2019
Merged

Conversation

mliu49
Copy link
Contributor

@mliu49 mliu49 commented Mar 27, 2019

Motivation or Problem

To make the installation instructions easier to read and reference.

Description of Changes

  • Fix spacing/indentation issues
  • Convert bullet points to numbering to allow easier referencing
  • Update dependencies list in documentation
  • Move installation FAQ to main FAQ page
  • Add more FAQs
  • Make Arkane.py executable
    (Reviewer note: since this is very unrelated, let me know if you would prefer this to be in a separate PR)

Testing

Make the html documentation and look at the modified pages.

@mliu49 mliu49 self-assigned this Mar 27, 2019
@mliu49 mliu49 requested a review from amarkpayne March 27, 2019 22:37
@codecov
Copy link

codecov bot commented Mar 28, 2019

Codecov Report

Merging #1567 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1567      +/-   ##
==========================================
+ Coverage   41.85%   41.87%   +0.01%     
==========================================
  Files         165      165              
  Lines       28004    28004              
  Branches     5713     5713              
==========================================
+ Hits        11721    11726       +5     
+ Misses      15494    15490       -4     
+ Partials      789      788       -1
Impacted Files Coverage Δ
rmgpy/data/kinetics/family.py 58.56% <0%> (+0.29%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 425879e...21e092d. Read the comment docs.

Copy link
Member

@amarkpayne amarkpayne left a comment

Choose a reason for hiding this comment

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

Everything is showing up on my end as you intended, and the numbering system is far superior to our old bullet point system. I am also fine with the commit to make Arkane.py executable--I think it is closely related enough as to be included in this PR. Finally, I also checked that everything in the FAQ section got moved over properly. I'll go ahead and merge this--thanks for the great PR!!

@amarkpayne amarkpayne merged commit 45b8a13 into master Mar 29, 2019
@amarkpayne amarkpayne deleted the doc_fixes branch March 29, 2019 20:18
@amarkpayne amarkpayne removed the Status: Ready for Review PR is complete and ready to be reviewed label Mar 29, 2019
@mliu49 mliu49 mentioned this pull request May 15, 2019
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants