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

Remove old code and documentation, adding a doc placeholder. #42

Merged
merged 12 commits into from
Nov 21, 2018

Conversation

kiddinn
Copy link
Member

@kiddinn kiddinn commented Nov 13, 2018

Removing older code that is no longer needed as well as re-generating the documentation with a placeholder (as in really delete the documentation)

Copy link
Contributor

@Onager Onager left a comment

Choose a reason for hiding this comment

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

Please add doc/build to gitignore - we don't want all that autogenerated stuff in the source tree. Take a look at Plaso's readthedocs and sphinx configs for example.

@kiddinn
Copy link
Member Author

kiddinn commented Nov 20, 2018

deleted the autogenerated docs, and changed gitignore

@kiddinn kiddinn requested a review from Onager November 20, 2018 14:16
@kiddinn
Copy link
Member Author

kiddinn commented Nov 20, 2018

can you review again?

Copy link
Contributor

@Onager Onager left a comment

Choose a reason for hiding this comment

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

The sphinx config doesn't actually generate any useful docs any more - was that what you wanted to do here? It also refers to "l2t scaffolder" which doesn't exist (yet). Can you please make the sphinx config consistent and some placeholder text to index.rst calling out that there's no documentation.
Alternatively, you could set up the sphinx config to generate autodoc, in a similar manner to Plaso etc.

@kiddinn
Copy link
Member Author

kiddinn commented Nov 21, 2018

yes, that was the intention, the intention of this PR was mainly to delete old files, not to really setup sphinx for document creation.

The intent was to do that in another PR.

@kiddinn kiddinn requested a review from Onager November 21, 2018 09:17
@kiddinn
Copy link
Member Author

kiddinn commented Nov 21, 2018

and yes, I changed the index.rst file a bit to indicate that there isn't any documentation ATM

@kiddinn kiddinn changed the title Remove old code and generating new documentation Remove old code and documentation, adding a doc placeholder. Nov 21, 2018
@kiddinn
Copy link
Member Author

kiddinn commented Nov 21, 2018

also changed the name and description of the PR to reflect my actual intention

@Onager Onager merged commit e682af5 into log2timeline:master Nov 21, 2018
scaffolder v2 automation moved this from In Review to Completed Nov 21, 2018
@kiddinn kiddinn deleted the remove_old_code branch November 21, 2018 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
scaffolder v2
  
Completed
Development

Successfully merging this pull request may close these issues.

None yet

2 participants