dhmit / gender_analysis

A toolkit for analyzing gendered language across sets of documents
BSD 3-Clause "New" or "Revised" License
11 stars 5 forks source link

Build public-facing documentation #40

Closed ryaanahmed closed 3 years ago

ryaanahmed commented 5 years ago

We want, ideally, two things:

  1. an easy-to-read user's guide / tutorial that walks a user through creating a simple project using our toolkit
  2. comprehensive API documentation, probably automatically generated

We're going to use

ryaanahmed commented 5 years ago

I'm not assigning this now, but I'd suggest that the test projects you're creating this week can feed into the user's guide.

I'll do the initial Sphinx setup.

ryaanahmed commented 5 years ago

Outline doc for the user's guide: https://docs.google.com/document/d/1JXodqJZNiI76qbNnJhujHc4C8IN4V43S0xnZkm7vsk0/edit?ts=5d1b754e

ryaanahmed commented 5 years ago

Some good examples: http://web.mit.edu/music21/doc/usersGuide/usersGuide_01_installing.html https://guide.elm-lang.org/

ryaanahmed commented 5 years ago

https://gender-analysis.readthedocs.io/

ryaanahmed commented 5 years ago

@samimak37 -- Sphinx has a bunch of warnings that explain why some of the formatting is funky. You can install Sphinx into your venv with pip, and then go to documentation/source and run make html locally.

ryaanahmed commented 5 years ago

Let's add 'next' and 'previous' to the bottom of pages on the user's guide (i.e., so that users on the "Installation" page can click through to "tutorial" etc.)

MBJean commented 3 years ago

This issue is concluded as of PR #154. Closing.