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

Removed duplicate doc files #270

Merged
merged 7 commits into from Oct 9, 2019
Merged

Conversation

uppittu11
Copy link
Member

PR Summary:

Fixes #269

PR Checklist


  • Includes appropriate unit test(s)
  • Appropriate docstring(s) are added/updated
  • Code is (approximately) PEP8 compliant
  • Issue(s) raised/addressed?

@codecov
Copy link

codecov bot commented Oct 7, 2019

Codecov Report

Merging #270 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #270   +/-   ##
=======================================
  Coverage   85.75%   85.75%           
=======================================
  Files          10       10           
  Lines        1137     1137           
=======================================
  Hits          975      975           
  Misses        162      162

@mattwthompson
Copy link
Member

Just to check, it looks like forcefields.rst isn't a part of the current docs site?

https://mosdef.org/foyer/index.html

Although there's a mismatch in the filename (https://mosdef.org/foyer/forcefields.html) and title (Parameter definitions) which seems to be a part of the confusion

@uppittu11
Copy link
Member Author

It looks like the website was looking in forcefield.rst for the Parameter Definitions page. I believe this is fixed with the update to index.rst, but I have not rebuilt the website and verified this yet.

@ahy3nz
Copy link
Contributor

ahy3nz commented Oct 8, 2019

Yeah looks like the docs need forcefields.rst to make the "parameter definitions page" while parameter_definitions.rst doesn't make that page. I'm just selectively removing these rst files, make clean, make dirhtml and looking at the resultant documentation pages, but I'm curious why parameter_definitions.rst doesn't get compiled into the docs

Copy link
Member

@mattwthompson mattwthompson left a comment

Choose a reason for hiding this comment

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

Approving because Parashara was able to build this locally 👍

@mattwthompson mattwthompson merged commit b5485a4 into mosdef-hub:master Oct 9, 2019
@uppittu11 uppittu11 deleted the iss269 branch October 9, 2019 22:46
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.

Duplicate RST files in foyer/docs
4 participants