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

Merge API markdown files into Readme #10

Closed
Subhash3 opened this issue Jun 3, 2021 · 4 comments
Closed

Merge API markdown files into Readme #10

Subhash3 opened this issue Jun 3, 2021 · 4 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Subhash3
Copy link
Owner

Subhash3 commented Jun 3, 2021

Docs are currently stored in docs/markdown/*.md. I want to merge all those .md files and embed the markdown in the root README under the API section.

@Subhash3 Subhash3 added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jun 3, 2021
@sawradip
Copy link
Contributor

sawradip commented Jun 3, 2021

Hello Subhash. You have an awesome project here. Implementing NNs from scratch is one of my cherished goals.

I would like to handle this issue. This is my first time contributing to an open source project. It would be great if you could elaborate me if the task is just to adding the contents on docs folder to the readme file?

@Subhash3
Copy link
Owner Author

Subhash3 commented Jun 4, 2021

Thanks a lot for checking out this repo @sawradip.

Yes, I want the docs/markdown/*.md files to be merged and written into the README file. But, I want to automate this process.

Here is what I mean:

  • The markdown files in docs/markdown are generated by nicedoc/generate_markdown_api.py.
  • I want to create another script that can merge those .md files and write the contents into the README under the API section.
  • So, the readme would look something like:
..............
..............
# API
(Merged contents of docs/markdown/*.md)
...............
...............

@Subhash3 Subhash3 pinned this issue Jun 4, 2021
@sawradip
Copy link
Contributor

sawradip commented Jun 4, 2021

I am looking into this @Subhash3

@Subhash3 Subhash3 closed this as completed Jun 9, 2021
@Subhash3
Copy link
Owner Author

Subhash3 commented Jun 9, 2021

Checkout the fix here

Subhash3 added a commit that referenced this issue Jun 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants