Preliminary work to make local debugging of jekyll work. (#1239)

Running jekyll locally requires a Gemfile and null '---' header to convert .md files to .html (otherwise jekyll doesn't touch these files.) Also added google_analytics to _config.yml.  Both _layout/*.md files appear to support this already.

Resolves #1239

PiperOrigin-RevId: 457573545

docs/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "webrick"
+gem "github-pages", "~> 226", group: :jekyll_plugins

docs/_config.yml

@@ -1,6 +1,12 @@
 theme: jekyll-theme-minimal
 
+google_analytics: G-G896Q7VERJ
+
 defaults:
+  - scope:
+      path: ""
+    values:
+      layout: default
   - scope:
       path: developers
     values:

docs/_layouts/dev_guide.html

@@ -66,6 +66,8 @@ <h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repo
           <a href="{{ "developers/style_guide.html" | relative_url }}">Style guide</a>
           <br />
           <a href="{{ "developers/tools.html" | relative_url }}">Tools</a>
+          <br />
+          <a href="{{ "developers/debug_docs.html" | relative_url }}">Debug documentation</a>
         </p>
 
         {% if site.github.is_project_page %}

docs/developers/debug_docs.md

@@ -0,0 +1,53 @@
+# How to setup environment for previewing changes to documentation
+
+<!--* freshness: { owner: 'rechen' reviewed: '2022-06-27' } *-->
+
+The pytype documentation is in markdown format.
+
+github uses [jekyll](https://jekyllrb.com/docs/) to render these pages.
+
+## Prerequisites
+
+Install/update ruby and bundler
+
+```shell
+ruby -v # should be greater than 3.0.0
+```
+
+If it doesn't exist or is too old
+
+```shell
+sudo apt-get install ruby-full
+```
+
+Add path to your .bashrc
+
+```shell
+echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
+echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
+echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
+source ~/.bashrc
+```
+
+Install packages required for jekyll
+
+```shell
+gem install jekyll bundler webrick
+gem update jekyll
+bundle install
+```
+
+## Start jekyll locally
+
+```shell
+cd docs # you'll need to be in the pytype/docs directory
+
+bundle exec jekyll serve --watch
+```
+
+The `--watch` flag forces jekyll to look for changes to your source files and
+reload the server if it detects any changes.
+
+You can view your webpages by navigating to
+[http://localhost:4000](http://localhost:4000) like
+[http://localhost:4000/developers/index.html](http://localhost:4000/developers/index.html)