Skip to content

csctd/profile-website-brownsarahm-3

Repository files navigation

Open in Codespaces

Sphinx Profile Page

This is is a template for a resume/ personal portfolio, built with Sphinx! Based on Chris Holdgraf's personal site

This template is designed for use in the URI CS TD SSP.

Tips for Updating the Content of this site

  • sidebar variables are defined in info-.yml
  • sidebar formatting for sidebar is in _templates/hello.html
  • variables are used via html_context
  • get social links back by removing setting to navbar_end in conf.py and set values by example

To work with this repo offline (or in codespaces)

This requires having python installed then installs a package that helps build the website

The easiest way to build the website is to use nox, which handles all of the environment generation automatically. To do so, follow these steps:

  1. Install nox.

    pip install -U nox
  2. To run a live webserver that will auto-build and reload when you make changes, run:

nox -s docs-live

If on Codespaces, use accept the port forwarding and open the forwarded port in a new browser tab to preview your site while you work.