solves issue 1287 : Created structure of the doc using sphinx #1550
Conversation
Signed-off-by: TG1999 <[email protected]>
|
Thanks, in this way you have to search issue and solve. |
|
|
|
Thanks, @Abhishek-Dev09 for guiding |
Codecov Report
@@ Coverage Diff @@
## develop #1550 +/- ##
==========================================
+ Coverage 84.32% 84.4% +0.07%
==========================================
Files 124 124
Lines 14594 14594
==========================================
+ Hits 12307 12318 +11
+ Misses 2287 2276 -11
Continue to review full report at Codecov.
|
|
Hi @Abhishek-Dev09 @pombredanne can you suggest me how to resolve this. I have not changed these files in my commit so I don't know how it affected the code coverage . |
Signed-off-by: TG1999 <[email protected]>
|
Now the code has passed all the checks, please review the changes |
|
Thank you ++ |
There was a problem hiding this comment.
Thank you! See my comments inline. Also read this https://github.com/nexB/aboutcode/wiki/Writing-good-commit-messages
src/scancode/api.py
Outdated
|
|
||
| # FIXME: for sanity this should always be included????? | ||
| if include_text: | ||
| matched_text = match.matched_text(whole_lines=False) |
There was a problem hiding this comment.
Can you remove this?
- this is not about the documentation ticket Create basic documentation structure and tooling to build and publish #1287
- even if you were to submit it separately this would not be accepted because the matched license text is something that is collected once for a match and not once for each license key in the match license expression, so your fix would make things go much much slower by recollecting the matched_text several times in the cases where there is more than one license in a detected rule
There was a problem hiding this comment.
Can you remove that? Thanks!
docs/intro.rst
Outdated
| @@ -0,0 +1,194 @@ | |||
| ================ | |||
There was a problem hiding this comment.
I like this but there is a problem that it creates: we now have duplicated content in this intro and in the README.rst. that's likely a source of divergence and rework. What could you do instead to avoid this?
docs/conf.py
Outdated
|
|
||
| # -- Project information ----------------------------------------------------- | ||
|
|
||
| project = 'AbutCode' |
There was a problem hiding this comment.
Here we are in the ScanCode toolkit subproject, not the top level AboutCode
docs/conf.py
Outdated
| # -- Project information ----------------------------------------------------- | ||
|
|
||
| project = 'AbutCode' | ||
| copyright = '2019, Tushar' |
There was a problem hiding this comment.
I appreciate that you push your copyright there, but I would prefer something more neutral such as " the ScanCode-toolkit authors and contributors or something like there is elsewhere in the code. You also need to ensure that this is detectable with ScanCode. Same for author below
docs/index.rst
Outdated
| @@ -0,0 +1,20 @@ | |||
| .. AbutCode documentation master file, created by | |||
There was a problem hiding this comment.
That would be ScanCode here and below
Signed-off-by: TG1999 <[email protected]>
|
@pombredanne I have made the changes as per your review. |
Upsync the branch
src/scancode/api.py
Outdated
|
|
||
| # FIXME: for sanity this should always be included????? | ||
| if include_text: | ||
| matched_text = match.matched_text(whole_lines=False) |
There was a problem hiding this comment.
Can you remove that? Thanks!
|
@TG1999 also its looks like @DennisClark pushed the basic doc structure with this commit 415d0c8 |
Signed-off-by: TG1999 <[email protected]>
Signed-off-by: TG1999 <[email protected]>
Signed-off-by: TG1999 <[email protected]>
Signed-off-by: TG1999 <[email protected]>
|
@DennisClark Should this be moved to aboutcode? If so I will close and redirect the student to the proper location. |
|
Changes to this have become stale. |
4 participants
I have used README.rst for making the doc. Solves #1287. Please review