Skip to content
This repository was archived by the owner on Feb 2, 2024. It is now read-only.

Fix README #786

Merged
AlexanderKalistratov merged 18 commits into from
Mar 26, 2020
Merged

Fix README #786

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
8dd6096
Add links, shring long lines
PokhodenkoSA Mar 26, 2020
6614155
Remove ", which"
PokhodenkoSA Mar 26, 2020
7ffefc9
Replace Intel SDC with Intel® SDC in README
PokhodenkoSA Mar 26, 2020
a74d58a
Add newline after header
PokhodenkoSA Mar 26, 2020
1847588
Add highlite to intel/label/beta
PokhodenkoSA Mar 26, 2020
f211883
try code block
PokhodenkoSA Mar 26, 2020
a45e87d
Use sdc-env as default environment for sdc
PokhodenkoSA Mar 26, 2020
2213578
try code-blocks
PokhodenkoSA Mar 26, 2020
33f433d
Use conda-build-env and sdc-env for build environments
PokhodenkoSA Mar 26, 2020
7c73c17
Add newline for headers
PokhodenkoSA Mar 26, 2020
854cb45
Replace Sphinx* with link
PokhodenkoSA Mar 26, 2020
83c7b9f
Fix hidden note. I think it was by typo mistake.
PokhodenkoSA Mar 26, 2020
46e958e
Format notes about using from intel/label/beta channel
PokhodenkoSA Mar 26, 2020
e9b586d
Paste , before please
PokhodenkoSA Mar 26, 2020
09618b2
Fix long line
PokhodenkoSA Mar 26, 2020
21a0673
Rerplace Pandas* with `Pandas*`_ link.
PokhodenkoSA Mar 26, 2020
eb42a35
Fix long lines and replace Pandas* with links
PokhodenkoSA Mar 26, 2020
13752d8
Replace Sphinx with links
PokhodenkoSA Mar 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add newline for headers
  • Loading branch information
@PokhodenkoSA
PokhodenkoSA committed Mar 26, 2020
commit 7c73c1795948f5cd2da3d640eb8550a425a5223d
6 changes: 4 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,9 @@ Troubleshooting Windows Build
and add a string value named ``14.0`` whose data is ``C:\Program Files (x86)\Microsoft Visual Studio 14.0\``.
* Sometimes if the conda version or visual studio version being used are not latest then building Intel® SDC can throw some vague error about a keyword used in a file. So make sure you are using the latest versions.


Building documentation
----------------------

Building Intel® SDC User's Guide documentation requires pre-installed Intel® SDC package along with compatible Pandas* version as well as Sphinx* 2.2.1 or later.

Intel® SDC documentation includes Intel® SDC examples output which is pasted to functions description in the API Reference.
Expand Down Expand Up @@ -173,6 +173,7 @@ To preview the documentation open ``index.html`` file.

Sphinx* Generation Internals
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The documentation generation is controlled by ``conf.py`` script automatically invoked by Sphinx.
See `Sphinx documentation <http://www.sphinx-doc.org/en/master/usage/configuration.html>`_ for details.

Expand All @@ -185,7 +186,8 @@ located at ``./sdc/docs/source/_api_ref`` directory.
Sphinx will automatically clean the ``_api_ref`` directory on the next invocation of the documenation build.

Intel® SDC docstring decoration rules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Since SDC API Reference is auto-generated from respective Pandas* and Intel® SDC docstrings there are certain rules that must be
followed to accurately generate the API description.

Expand Down