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

Create live url links for all URLs in documents. #5784

Merged
merged 1 commit into from
Aug 8, 2016

Conversation

michael-okeefe
Copy link
Contributor

Pull request overview

This pull request wraps all URLs in the document in a \url{} or \href{}{} wrapper such that the generated PDFs (or HTML) will use live, click-able links. This also makes it somewhat easier to identify URLs in the document should we want to automatically check to see if they still work and such. This pull request has not evaluated the given URLs for relevancy or whether they still work, etc.

Work Checklist

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • At least one of the following appropriate labels must be added to this PR to be consumed into the changelog:
    • Defect: This pull request repairs a github defect issue. The github issue should be referenced in the PR description
    • Refactoring: This pull request includes code changes that don't change the functionality of the program, just perform refactoring
    • NewFeature: This pull request includes code to add a new feature to EnergyPlus
    • Performance: This pull request includes code changes that are directed at improving the runtime performance of EnergyPlus
    • DoNoPublish: This pull request includes changes that shouldn't be included in the changelog

Review Checklist

This will not be exhaustively relevant to every PR.

  • Code style (parentheses padding, variable names)
  • Functional code review (it has to work!)
  • If defect, results of running current develop vs this branch should exhibit the fix
  • CI status: all green or justified
  • Performance: CI Linux results include performance check -- verify this
  • Unit Test(s)
  • C++ checks:
    • Argument types
    • If any virtual classes, ensure virtual destructor included, other things
  • IDD changes:
    • Verify naming conventions and styles, memos and notes and defaults
    • Open windows IDF Editor with modified IDD to check for errors
    • If transition, add rules to spreadsheet
    • If transition, add transition source
    • If transition, update idfs
  • If new idf included, locally check the err file and other outputs
  • Documentation changes in place
  • ExpandObjects changes??
  • If output changes, including tabular output structure, add to output rules file for interfaces

Note: this will make it easier to scrub and test URLs in the future.

Note: this will make it easier to scrub and test URLs in the future.
@michael-okeefe michael-okeefe added the Documentation Related primarily on the LaTeX-based EnergyPlus documentation label Jul 20, 2016
@mjwitte mjwitte added the Defect Includes code to repair a defect in EnergyPlus label Jul 21, 2016
@nrel-bot-3
Copy link

@michael-okeefe @lgentile it has been 16 days since this pull request was last updated.

@Myoldmopar Myoldmopar merged commit f67fca4 into develop Aug 8, 2016
@Myoldmopar Myoldmopar deleted the make-urls-in-docs-live branch August 8, 2016 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Defect Includes code to repair a defect in EnergyPlus Documentation Related primarily on the LaTeX-based EnergyPlus documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants