docs: adjust style of the landing page (microsoft#191)

mxschmitt · web-flow · commit 542c3a7e5e5f · 2020-09-16T00:29:12.000+02:00
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -7,6 +7,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+    - name: Set up Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12.x
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
@@ -18,6 +22,8 @@ jobs:
         pip install -e .
     - name: Generate docs
       run: pdoc3 --html -o htmldocs playwright
+    - name: Post doc generation
+      run: node scripts/postPdoc3Generation.js
     - name: Deploy
       uses: peaceiris/actions-gh-pages@v3
       with:
diff --git a/playwright/__init__.py b/playwright/__init__.py
@@ -11,6 +11,13 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+"""
+Python package `playwright` is a Python library to automate Chromium,
+Firefox and WebKit with a single API. Playwright is built to enable cross-browser
+web automation that is ever-green, capable, reliable and fast.
+For more information you'll find the documentation for the sync API [here](sync_api.html)
+and for the async API [here](async_api.html).
+"""
 
 import playwright.helper as helper
 from playwright.main import AsyncPlaywrightContextManager, SyncPlaywrightContextManager
@@ -33,3 +40,37 @@ def sync_playwright() -> SyncPlaywrightContextManager:
     "Error",
     "TimeoutError",
 ]
+
+__pdoc__ = {
+    "accessibility": False,
+    "async_base": False,
+    "browser": False,
+    "browser_context": False,
+    "browser_type": False,
+    "cdp_session": False,
+    "chromium_browser_context": False,
+    "connection": False,
+    "console_message": False,
+    "dialog": False,
+    "download": False,
+    "element_handle": False,
+    "event_context_manager": False,
+    "file_chooser": False,
+    "frame": False,
+    "helper": False,
+    "impl_to_api_mapping": False,
+    "input": False,
+    "js_handle": False,
+    "main": False,
+    "network": False,
+    "object_factory": False,
+    "page": False,
+    "path_utils": False,
+    "playwright": False,
+    "selectors": False,
+    "sync_base": False,
+    "transport": False,
+    "wait_helper": False,
+    "async_playwright": False,
+    "sync_playwright": False,
+}
diff --git a/scripts/postPdoc3Generation.js b/scripts/postPdoc3Generation.js
@@ -0,0 +1,7 @@
+const fs = require('fs');
+
+// Removes the sidebar on the landing page (/)
+const indexPath = 'htmldocs/playwright/index.html';
+let input = fs.readFileSync(indexPath).toString();
+input = input.replace(/<nav id="sidebar">.*<\/nav>/s, '');
+fs.writeFileSync(indexPath, input);
