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

Move GSProcessing docs to main repo documentation. #502

Merged
merged 5 commits into from
Sep 28, 2023

Conversation

thvasilo
Copy link
Contributor

Issue #, if available:

Description of changes:

Move the GSProcessing docs under the main repo to allow publishing under common readthedocs project.

Add a new "Distributed Processing" section at the index root, rename "Scale to Giant Graphs" to "Distributed Training" to differentiate between processing and training.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@thvasilo thvasilo added documentation Improvements or additions to documentation v0.2 labels Sep 28, 2023
@thvasilo thvasilo requested a review from zhjwy9343 September 28, 2023 01:32
@thvasilo thvasilo self-assigned this Sep 28, 2023
@zhjwy9343
Copy link
Contributor

If we move these docs to the main /docs repo, are these make, conf.py files necessary. Can we remove them?

@thvasilo
Copy link
Contributor Author

If we move these docs to the main /docs repo, are these make, conf.py files necessary. Can we remove them?

This PR removes them.

@zhjwy9343
Copy link
Contributor

When I run Sphinx make html. Get the following warning and errors. Could you take a look?

/data/theo/graphstorm/docs/source/gs-processing/developer/developer-guide.rst:37: WARNING: Title underline too short.

Install ``pyenv``
~~~~~~~~~~~~~
/data/theo/graphstorm/docs/source/gs-processing/developer/developer-guide.rst:37: WARNING: Title underline too short.

Install ``pyenv``
~~~~~~~~~~~~~
/data/theo/graphstorm/docs/source/gs-processing/developer/developer-guide.rst:75: WARNING: Title underline too short.

Install ``poetry``
~~~~~~~~~~~~~~
/data/theo/graphstorm/docs/source/gs-processing/developer/developer-guide.rst:75: WARNING: Title underline too short.

Install ``poetry``
~~~~~~~~~~~~~~
/data/theo/graphstorm/docs/source/gs-processing/developer/developer-guide.rst:85: WARNING: Title underline too short.

Install dependencies through ``poetry``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/data/theo/graphstorm/docs/source/gs-processing/developer/developer-guide.rst:85: WARNING: Title underline too short.

Install dependencies through ``poetry``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/data/theo/graphstorm/docs/source/gs-processing/developer/developer-guide.rst:180: WARNING: Title underline too short.

Use a pre-commit hook to ensure ``black`` and ``pylint`` runs before commits
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/data/theo/graphstorm/docs/source/scale/distributed.rst:4: WARNING: Duplicate explicit target name: "nfs tutorial".
/data/theo/graphstorm/docs/source/scale/distributed.rst:4: WARNING: Duplicate explicit target name: "nfs guide".
looking for now-outdated files... none found
pickling environment... done
checking consistency... /data/theo/graphstorm/docs/source/gs-processing/developer/developer-guide.rst: WARNING: document isn't included in any toctree
/data/theo/graphstorm/docs/source/gs-processing/developer/input-configuration.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] tutorials/quick-start                                                                                                                                                                                                                                
/data/theo/graphstorm/docs/source/gs-processing/usage/amazon-sagemaker.rst:37: WARNING: unknown document: '/usage/distributed-processing-setup'
/data/theo/graphstorm/docs/source/gs-processing/usage/amazon-sagemaker.rst:54: WARNING: unknown document: '/usage/distributed-processing-setup'
/data/theo/graphstorm/docs/source/tutorials/own-data.rst:262: WARNING: Could not lex literal_block as "json". Highlighting skipped.

@zhjwy9343
Copy link
Contributor

zhjwy9343 commented Sep 28, 2023

After compile the latest commit, I found there is a place like,
For more info on pyen see its documentation. <https://github.com/pyenv/pyenv> in the develop-guide.html.
But I cannot find this in the source code. Do you know where it is? And fix this anchor format.

Copy link
Contributor

@zhjwy9343 zhjwy9343 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@thvasilo thvasilo merged commit 601701a into awslabs:main Sep 28, 2023
@thvasilo thvasilo deleted the merge-gsp-docs branch September 28, 2023 23:03
classicsong added a commit that referenced this pull request Sep 29, 2023
*Issue #, if available:*

*Description of changes:*

Move the GSProcessing docs under the main repo to allow publishing under
common readthedocs project.

Add a new "Distributed Processing" section at the index root, rename
"Scale to Giant Graphs" to "Distributed Training" to differentiate
between processing and training.


By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.

---------

Co-authored-by: xiang song(charlie.song) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v0.2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants