Skip to content

DOC [PST] tune FAQ page styling #28448

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Apr 10, 2024
Merged

DOC [PST] tune FAQ page styling #28448

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2bb206c
[doc build] tweak faq page styling
Charlie-XIAO Feb 18, 2024
ea979e8
[doc build] styling
Charlie-XIAO Feb 18, 2024
b3206b0
Merge remote-tracking branch 'upstream/new_web_theme' into pst-faq
Charlie-XIAO Mar 11, 2024
1cbbc0d
Merge remote-tracking branch 'upstream/new_web_theme' into pst-faq
Charlie-XIAO Mar 12, 2024
b946c3e
add back the top toc and remove backlink styles
Charlie-XIAO Mar 12, 2024
b0f84bb
only remove text-decoration
Charlie-XIAO Mar 14, 2024
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
46 changes: 39 additions & 7 deletions doc/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
.. raw:: html

<style>
/* h3 headings on this page are the questions; make them rubric-like */
h3 {
font-size: 1rem;
font-weight: bold;
padding-bottom: 0.2rem;
margin: 2rem 0 1.15rem 0;
border-bottom: 1px solid var(--pst-color-border);
}

/* Increase top margin for first question in each section */
h2 + section > h3 {
margin-top: 2.5rem;
}

/* Make the headerlinks a bit more visible */
h3 > a.headerlink {
font-size: 0.9rem;
}

/* Remove the backlink decoration on the titles */
h2 > a.toc-backref,
h3 > a.toc-backref {
text-decoration: none;
}
</style>

.. _faq:

==========================
Expand All @@ -9,8 +38,9 @@ Frequently Asked Questions
Here we try to give some answers to questions that regularly pop up on the mailing list.

.. contents:: Table of Contents
:local:
:depth: 2
:local:
:depth: 2


About the project
-----------------
Expand Down Expand Up @@ -313,12 +343,14 @@ Using scikit-learn

What's the best way to get help on scikit-learn usage?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**For general machine learning questions**, please use
`Cross Validated <https://stats.stackexchange.com/>`_ with the ``[machine-learning]`` tag.

**For scikit-learn usage questions**, please use `Stack Overflow <https://stackoverflow.com/questions/tagged/scikit-learn>`_
with the ``[scikit-learn]`` and ``[python]`` tags. You can alternatively use the `mailing list
<https://mail.python.org/mailman/listinfo/scikit-learn>`_.
* General machine learning questions: use `Cross Validated
<https://stats.stackexchange.com/>`_ with the ``[machine-learning]`` tag.

* scikit-learn usage questions: use `Stack Overflow
<https://stackoverflow.com/questions/tagged/scikit-learn>`_ with the
``[scikit-learn]`` and ``[python]`` tags. You can alternatively use the `mailing list
<https://mail.python.org/mailman/listinfo/scikit-learn>`_.

Please make sure to include a minimal reproduction code snippet (ideally shorter
than 10 lines) that highlights your problem on a toy dataset (for instance from
Expand Down