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

docs: Initial setup of documentation website. #234

Merged
merged 22 commits into from
Jan 14, 2021
Merged

Conversation

butler54
Copy link
Collaborator

Signed-off-by: Chris Butler chris@thebutlers.me

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • All commits are signed.

This is an initial setup for a documentation website as described in #83. Given the complexity of our current build process I've chosen so far the simplest possible path - that is a github 'project page' (as opposed to an organizational page OR read the docs).

Note that some of the api docs will not be resolved correctly until the models are updated in #233 to produce the cleanest possible outcomes.

NOTE: Draft at this stage and expecting substantial feedback will be required to get this where we want it to be.

Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
@butler54 butler54 requested review from aNebula and fsuits November 23, 2020 02:46
@codecov
Copy link

codecov bot commented Nov 23, 2020

Codecov Report

Merging #234 (bd83d07) into develop (1ebbeb2) will decrease coverage by 0.01%.
The diff coverage is 85.71%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #234      +/-   ##
===========================================
- Coverage    98.56%   98.54%   -0.02%     
===========================================
  Files           50       50              
  Lines         5710     5712       +2     
===========================================
+ Hits          5628     5629       +1     
- Misses          82       83       +1     
Impacted Files Coverage Δ
trestle/core/const.py 100.00% <ø> (ø)
trestle/core/err.py 92.30% <ø> (ø)
trestle/core/parser.py 95.45% <ø> (ø)
trestle/utils/load_distributed.py 100.00% <ø> (ø)
trestle/core/base_model.py 93.04% <85.71%> (-0.77%) ⬇️

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 1ebbeb2...ea75e88. Read the comment docs.

Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
@butler54 butler54 self-assigned this Nov 24, 2020
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
Signed-off-by: Chris Butler <chris@thebutlers.me>
@butler54 butler54 requested a review from DrJohnWagner January 12, 2021 10:03
@butler54 butler54 marked this pull request as ready for review January 12, 2021 10:03
@butler54
Copy link
Collaborator Author

Ready for review.

Copy link
Contributor

@aNebula aNebula left a comment

Choose a reason for hiding this comment

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

We need a small change in the doc for trestle merge to take only -e instead of -f and -d. I will make changes in the spec through the #295 .

docs/cli.md Outdated

would merge the properties inside each of the files passed in via the `-f` option to the destination file specified with the `-d` option.

In the near future, trestle merge should be smart enough to figure out which json files contain the elemenets that you want to be merged as well as the destination file that the elements should be placed into. In that case, both `-f` option and `-d` would be deprecated and the commands would look like:
Copy link
Contributor

Choose a reason for hiding this comment

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

For trestle merge, we have reached near future 😄 We don't need the -f or -d, but we need -e model.submodel, where submodel is merged into the model.

docs/cli.md Outdated Show resolved Hide resolved
Copy link
Contributor

@aNebula aNebula left a comment

Choose a reason for hiding this comment

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

LGTM

@butler54 butler54 merged commit a51081b into develop Jan 14, 2021
@butler54 butler54 deleted the docs/trestle-website branch February 24, 2021 03:25
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.

2 participants