I have already explored the repository of sympy and have seen the work done by Google Season of Docs 2022 mentee .Currently I am going through sphinx official documentation to be able to do this project with utmost proficiency.
Any pointers pointers regarding the further process would be really appreciated. My github profile link-https://github.com/soma2000-lang Regards On Thu, 19 Jan 2023, 05:01 Somasree Majumder, < bishnupadamajumde...@gmail.com> wrote: > Hi there Sympy Community, > > > I am Somasree Majumder, undergrad from India.I am really interested to > work on this project.I am quiet well versed with python and have been > contributing to open source python based softwares for 2 years now.As far > as techjical writing is concerned I write articles on Machine learning and > python on Medium.I would like start contributing to sympy to better > understand the workflow.If this sounds ok I would like to discuss about > this further. > > Regards > > On Thu, 19 Jan 2023, 04:19 Aaron Meurer, <asmeu...@gmail.com> wrote: > >> Google has announced they are running Google Season of Docs again this >> year https://developers.google.com/season-of-docs. The deadline for us >> to apply is February 15. >> >> I'd like to apply again. Before we do that, though, we need to come up >> with a project idea. I'd also ideally like to find someone to hire before >> then too (unlike Google Summer of Code, Season of Docs works like a grant >> program. We apply for money from Google and if we are accepted they pay us >> and we hire someone). If you are interested in working with us, please >> reach out. >> >> This year, I'd like to focus on improving the overall quality of our >> reference "docstring" documentation. I'm open to other ideas, but I >> personally see this as the biggest deficiency in our documentation right >> now. The quality of our reference documentation varies from good to OK to >> bad to nonexistent. We have a documentation style guide that was written as >> part of a previous season of docs, but it is not followed everywhere >> https://docs.sympy.org/latest/contributing/documentation-style-guide.html >> . >> >> This project mostly would consist of various small cleanups to the >> existing documentation. For example: >> >> - There are also various little issues that are prevalent in the >> reference docs. For example, the misuse of single backticks, which >> currently create LaTeX, instead of double backticks (see >> https://github.com/sympy/sympy/issues/13519). >> >> - There's a lot of various grammatical errors in the docstrings. >> >> - There are a lot of functions that have docstrings but which aren't >> included in Sphinx, and would require little RST cleanups to include. >> >> These sorts of cleanups are not hard, but the issue is that we have a lot >> of documentation, so they will take a dedicated effort to do. >> >> Aaron Meurer >> >> -- >> You received this message because you are subscribed to the Google Groups >> "sympy" group. >> To unsubscribe from this group and stop receiving emails from it, send an >> email to sympy+unsubscr...@googlegroups.com. >> To view this discussion on the web visit >> https://groups.google.com/d/msgid/sympy/CAKgW%3D6JiL_MbCKVS-Mpb4r2GdjR_vTQv1-m4qCgmS%2BtypdY9PA%40mail.gmail.com >> <https://groups.google.com/d/msgid/sympy/CAKgW%3D6JiL_MbCKVS-Mpb4r2GdjR_vTQv1-m4qCgmS%2BtypdY9PA%40mail.gmail.com?utm_medium=email&utm_source=footer> >> . >> > -- You received this message because you are subscribed to the Google Groups "sympy" group. To unsubscribe from this group and stop receiving emails from it, send an email to sympy+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/CAG06GAMe-HtnT65_erjEdAp%2Bjr6VDLYeWT%2BRSy2Q-X%3DyYzPqrw%40mail.gmail.com.
