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

Documentation changes #168

Merged
merged 7 commits into from
Mar 11, 2022
Merged

Conversation

Pratikrocks
Copy link
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 [email protected]

@Pratikrocks Pratikrocks added the GSOC Project/issues to be done during the GSOC Time frame label Jun 28, 2021
Copy link
Contributor

@steven-esser steven-esser left a comment

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.

@Pratikrocks
Copy link
Collaborator Author

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

@Pratikrocks Pratikrocks linked an issue Jul 20, 2021 that may be closed by this pull request
@Pratikrocks Pratikrocks 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
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
Member

@Pratikrocks
Copy link
Collaborator Author

Yes it replaces the old one

@Pratikrocks
Copy link
Collaborator Author

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

@AyanSinhaMahapatra
Copy link
Member

AyanSinhaMahapatra commented Aug 18, 2021

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.

@Pratikrocks
Copy link
Collaborator Author

Alright I am doing it

Signed-off-by: Pratik Dey <[email protected]>
@@ -0,0 +1,67 @@
Google Summer of Code 2021 - Final report
Copy link
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
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