Contribution guide #4557
Contribution guide #4557
Conversation
J-shang
requested review from
liuzhe-lz,
QuanluZhang,
scarlett2018,
J-shang,
JiahangXu and
zheng-ningxin
|
@ultmaster @J-shang merge to the doc branch or master branch? |
docs/source/notes/contributing.rst
Outdated
| * We recommend documenting all the methods and classes in your code. Follow `NumPy Docstring Style <https://numpydoc.readthedocs.io/en/latest/format.html>`__ for Python Docstring Conventions. | ||
|
|
||
| * For function docstring, **description**, **Parameters**, and **Returns** are mandatory. | ||
| * For class docstring, **description**, **Attributes** are mandatory. The parameters of ``__init__`` should be documented in the docstring of docs. |
There was a problem hiding this comment.
what is the meaning of "docstring of docs"?
docs/source/notes/contributing.rst
Outdated
|
|
||
| .. tip:: The syntax to write a "notebook styled python file" is very simple. In essence, you only need to write a slightly well formatted python file. Here is a useful guide of `how to structure your Python scripts for Sphinx-Gallery <https://sphinx-gallery.github.io/stable/syntax.html>`_. | ||
|
|
||
| 2. Put the tutorials into ``docs/source/tutorials.rst``. You should add it it both ``toctree``, which makes it appear in the sidebar content table, and ``cardlinkitem``, and specify the appropriate ``header``, ``description``, ``link``, ``image``, ``background`` (for image) and ``tags``. |
|
|
||
| To contribute a new tutorial, here are the steps to follow: | ||
|
|
||
| 1. Create a notebook styled python file. If you want it executed while inserted into documentation, save the file under ``examples/tutorials/``. If your tutorial contains other auxiliary scripts which are not intended to be included into documentation, save them under ``examples/tutorials/scripts/``. |
There was a problem hiding this comment.
better to add a reference link to examples/tutorials, so that users can easily find complete examples there.
There was a problem hiding this comment.
I don't think it's necessary for "developers". They can easily find them in their cloned repo. We don't need to point to a possibly-outdated github address.
There was a problem hiding this comment.
so you imply that we should no use github address anyway?
There was a problem hiding this comment.
We should use them when we want to guide customers to read the repo on GitHub website.
I don't think it's very meaningful to have a doc branch at this point. Let's use the master branch. |
|
Docs like |
I don't think so, I think it is our provided feature |
got it |
| @@ -103,21 +83,3 @@ Automatic Feature Engineering | |||
| Automatic feature engineering is for users to find the best features for their tasks. A detailed description of automatic feature engineering and its usage can be found `here <FeatureEngineering/Overview.rst>`__. It is supported through NNI trial SDK, which means you do not have to create an NNI experiment. Instead, simply import a built-in auto-feature-engineering algorithm in your trial code and directly run your trial code. | |||
There was a problem hiding this comment.
is "here <FeatureEngineering/Overview.rst>__." this syntax still work?
There was a problem hiding this comment.
I find .rst can't work, here <FeatureEngineering/Overview.html>__. can work...
There was a problem hiding this comment.
another style is like this
@ultmaster we should provide guideline for it
If you have any questions on how to contribute, please let me know. I'll try to enrich the contents in this PR.