mkdocs.yml

site_name: Historiographing the Era of the American Revolution
site_url: https://revolution.readthedocs.io
repo_url: https://github.com/h-gear/revolution
repo_name: GitHub

nav:
  - Home: index.md
  - Source code: https://github.com/h-gear/revolution
  - Issues: https://github.com/h-gear/revolution/issues  
  - Background of the project:
    - Hgear: Background/BACKGROUND.md
    - Research questions: Background/QUESTIONS.md
    - Methods: Background/METHODS.md
    - Data: Background/DATA.md
  - Getting Started:
    - Installation: Started/INSTALLATION.md    
  - Data preparation and EDA:
    - Introduction: Analyses/INTRODUCTION.md
    - Scraping Letters of Delegates to Congress: Analyses/COLLECTION.md
    - Scraping Founding Fathers: Analyses/FFCOLLECTION.md
    - Data preparation Delegates of Congres: Analyses/PREPARATION_DEL.md
    - Data preparation Founding Fathers: Analyses/PREPARATION_FF.md
    - Exploratory analysis: Analyses/EXPLORE.md
    - Word2Vec models: Analyses/WORD2VEC.md 
  - Modeling:
    - Introduction: Modeling/INTRODUCTION.md
    - Semi-supervised topic modeling: Modeling/TOPICANALYSIS.md
    - Dynamic topic modeling: Modeling/DYNTOPICANALYSIS.md
    - Sentiment analysis: Modeling/SENTIMENT.md
    - Network modeling: Modeling/NETWORK.md
    - Time-respecting path-based network analysis: Modeling/MODELING.md
    - Geo-spatial model: Modeling/GEO.md
  - Developers:
    - Code of conduct: CODE_OF_CONDUCT.md    
    - Contributing guidelines: CONTRIBUTING.md    
  - About:
    - How to cite: About/CITE.md
    - Contact information: About/CONTACT.md
    - In action: About/ACTION.md    
     
theme:
  name: readthedocs
  
extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search
  - mkdocstrings:
      # https://mkdocstrings.github.io/usage/
      handlers:
        python:
          import:
          - https://docs.python.org/3/objects.inv
          - https://numpy.org/doc/stable/objects.inv
          - https://docs.scipy.org/doc/scipy/objects.inv
          - https://pandas.pydata.org/docs/objects.inv
          options:
            docstring_style: numpy
            docstring_options:
              ignore_init_summary: yes
            show_submodules: no
            show_source: true
            docstring_section_style: list
            members_order: alphabetical
            show_category_heading: no
            merge_init_into_class: yes

watch:
  - scripts
  - docs/