Skip to content

Documentation changes - #168

Merged
pombredanne merged 7 commits into
aboutcode-org:developfrom
pratik0316:documentation
Mar 11, 2022
Merged

Documentation changes#168
pombredanne merged 7 commits into
aboutcode-org:developfrom
pratik0316:documentation

Conversation

@pratik0316

Copy link
Copy Markdown
Collaborator

This PR is meant for updating the documentation at various locations in the codebase, as well as adding/updating an extensive docs in ReadTheDocs owing to the changes due to integration of the VirtualCodebase

Signed-off-by: Pratik Dey pratikrocks.dey11@gmail.com

@pratik0316 pratik0316 added the GSOC Project/issues to be done during the GSOC Time frame label Jun 28, 2021

@steven-esser steven-esser left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this just needs to be rebased with main; but this can be merged right after.

@pratik0316

Copy link
Copy Markdown
Collaborator Author

Yes we need to rebase it , and some modifications are required to in this PR

@pratik0316 pratik0316 linked an issue Jul 20, 2021 that may be closed by this pull request
Signed-off-by: Pratik Dey <pratikrocks.dey11@gmail.com>
Signed-off-by: Pratik Dey <pratikrocks.dey11@gmail.com>
Signed-off-by: Pratik Dey <pratikrocks.dey11@gmail.com>
Signed-off-by: Pratik Dey <pratikrocks.dey11@gmail.com>
…mage

Signed-off-by: Pratik Dey <pratikrocks.dey11@gmail.com>
@pratik0316 pratik0316 mentioned this pull request Aug 13, 2021
- Delete the directory in which you extracted DeltaCode.
- Delete any temporary files created in your system temp directory under a deltacode directory.

Using the docker image for testing Deltacode

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

This is the required instructions to run the docker image

@AyanSinhaMahapatra

Copy link
Copy Markdown
Member

@Pratikrocks does this replace the absolete docs at https://github.com/nexB/aboutcode/tree/master/docs/source/deltacode?

@pratik0316

Copy link
Copy Markdown
Collaborator Author

Yes it replaces the old one

@pratik0316

Copy link
Copy Markdown
Collaborator Author

Though the GSOC work report(.rst) is not present here

@AyanSinhaMahapatra

AyanSinhaMahapatra commented Aug 18, 2021

Copy link
Copy Markdown
Member

Right, then you could open a PR deleting them at https://github.com/nexB/aboutcode/tree/master/docs/source/deltacode and here link to the new docs.

The GSoC report can be added here in this PR (in deltacode RTD) also.

@pratik0316

Copy link
Copy Markdown
Collaborator Author

Alright I am doing it

Signed-off-by: Pratik Dey <pratikrocks.dey11@gmail.com>
@@ -0,0 +1,67 @@
Google Summer of Code 2021 - Final report

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

added the .rst here @AyanSinhaMahapatra

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@pombredanne
pombredanne merged commit 86bde34 into aboutcode-org:develop Mar 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

GSOC Project/issues to be done during the GSOC Time frame

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create DeltaCode documentation on ReadTheDocs

4 participants