DOC: Link to table schema and remove reference to internal API

[bharatr21]

• closes build_table_schema references non-existent _as_json_table_type #33130
• tests added / passed (Not needed)
• passes black pandas
• passes git diff upstream/master -u -- "*.py" | flake8 --diff (Markdown link which will not be shown)
• whatsnew entry (Not needed)

[pep8speaks]

Hello @Bharat123rox! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-04-26 18:02:03 UTC

[bharatr21]

Hello @Bharat123rox! Thanks for opening this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file pandas/io/json/_table_schema.py:

Line 214:89: E501 line too long (110 > 88 characters)

This is because of Markdown Link Text, the line will not be longer in the original documentation, so this should be okay

[alimcmaster1]

Hello @Bharat123rox! Thanks for opening this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file pandas/io/json/_table_schema.py:

Line 214:89: E501 line too long (110 > 88 characters)

This is because of Markdown Link Text, the line will not be longer in the original documentation, so this should be okay

Thanks for the PR. This will need to be fixed - we run flake8 in our code checks.

[bharatr21]

Thanks for the PR. This will need to be fixed - we run flake8 in our code checks.

@alimcmaster1 I believe that the long URL is readable (self-explanatory?) and should not be broken (also while rendering it won't be shown), hence it's a strong enough case to ignore the flake8 warning

[mroeschke]

I don't think this will render correctly in rst: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#links-to-external-web-pages

Also to pass flake8 you can just wrap this in the next line like this example:

    To learn more about the frequency strings, please see `this link
    <https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases>`__.

[bharatr21]

My bad, I thought Markdown was being used. @mroeschke Can you provide an example where link aliases are used?
Like

Get the latest news at `CNN`_.
.. _CNN: http://cnn.com/

[alimcmaster1]

If you wish to use an alias - see the spinx docs. https://sphinxtechnicalwriting.readthedocs.io/en/latest/sphinx/linking.html

gbq.py for an example.

You can build the documentation locally - https://pandas.pydata.org/pandas-docs/stable/development/contributing.html#how-to-build-the-pandas-documentation to check that it renders as expected. (Feel free to post a screenshot on PRs)

Thanks

[alimcmaster1]

Doc build seems to be failing - mind taking a look?

[bharatr21]

Doc build seems to be failing - mind taking a look?

Found this warning

/home/runner/miniconda3/envs/pandas-dev/lib/python3.8/site-packages/IPython/sphinxext/ipython_directive.py:1023: UserWarning: Code input with no code at /home/runner/work/pandas/pandas/doc/source/user_guide/computation.rst, line 624
  warnings.warn(message)
/home/runner/work/pandas/pandas/pandas/io/json/_table_schema.py:docstring of pandas.io.json.build_table_schema:45: WARNING: Explicit markup ends without a blank line; unexpected unindent.

But I didn't even touch line 45, so what is this really about?

[mroeschke]

Maybe just

See `table schema
<https://pandas.pydata.org/docs/user_guide/io.html#table-schema>`__ for...

[bharatr21]

Updated, let's hope doc builds!

[jreback]

did you build this page locally and see if it renders and the link works?

[bharatr21]

did you build this page locally and see if it renders and the link works?

@jreback I'm still having problems building docs locally in MacOS, but I did try it on an RST Previewer and it works fine

[WillAyd]

lgtm

[jreback]

thanks @Bharat123rox