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

Hide placeholders in docs #195

Merged
merged 5 commits into from
May 1, 2024
Merged

Hide placeholders in docs #195

merged 5 commits into from
May 1, 2024

Conversation

msaroufim
Copy link
Member

No description provided.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 1, 2024
@@ -4,85 +4,87 @@ Welcome to the torchao Documentation
**torchao** is an open-source library that provides the functionality
to quantize and prune your models using native PyTorch.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe add a note here that this website in under development and more content is coming soon?

:glob:
:maxdepth: 1
:caption: Tutorials
:hidden:
Copy link
Contributor

Choose a reason for hiding this comment

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

You can maybe also remove "hidden" from line 93 since this is the only content that will be available on this landing page.

@svekars
Copy link
Contributor

svekars commented May 1, 2024

To fix the build error, in the Makefile, change:

SPHINXOPTS    = -W -j auto $(EXAMPLES_PATTERN_OPTS)

to

SPHINXOPTS    = -WT --keep-going 

docs/Makefile Outdated Show resolved Hide resolved

.. toctree::
:glob:
:maxdepth: 1
:caption: API Reference
:hidden:

api_ref_intro
Copy link
Contributor

Choose a reason for hiding this comment

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

In the api_ref_intro.rst file need to change:

``torchao`` API Reference
=========================

to

torchao API Reference
====================

So that link doesn't appear in blue: https://docs-preview.pytorch.org/pytorch/ao/195/index.html

@msaroufim
Copy link
Member Author

Thank you @svekars!

@msaroufim msaroufim merged commit 9723178 into main May 1, 2024
13 checks passed
@msaroufim msaroufim deleted the msaroufim-patch-5 branch May 1, 2024 18:02
dbyoung18 pushed a commit to dbyoung18/ao that referenced this pull request Jul 31, 2024
* Hide placeholders in docs

* yolo

* yolo

* yolo

* Update docs/Makefile

---------

Co-authored-by: Svetlana Karslioglu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants