<commit_before>## Dataverse.org Navbar for SPHINX projects                                                   

Instructions to add the 'dataverse.org' navbar to Sphinx projects.

The placement of the following files into a Sphinx project will result in a dynamically loading (JSONP) navbar matching that of http://dataverse.org*.  

(* currently http://beta.dataverse.org)

### Instructions:                                                                       

1. Create a blank Sphinx ```navbar.html``` file
    - file location: ```{{ your sphinx project }}/source/_templates/navbar.html```
    - example: ```best_practices/source/_templates/navbar.html```

1. Copy the contents of ```sphinx-navbar.html``` file into ```navbar.html```         
    - content source: ```sphinx-navbar.html```
    - content target: ```{{ your sphinx project }}/source/_templates/navbar.html```
        - example: ```best_practices/source/_templates/navbar.html```
1. Copy the file ```navbar_from_dataverse_org.js``` to Sphinx
    - target location: ```{{ your sphinx project }}/source/_static/navbar_from_dataverse_org.js```
        - example: ```best_practices/source/_static/navbar_from_dataverse_org.js```
1. Run a build!  (take a break)


### Local testing

- Drag ```test_json_header.html`` into a browser
    - It should load the local ```navbar_from_dataverse_org.js``` file
    - The page will attempt to retrieve the navbar from the ```navbar_url``` specified in ```navbar_from_dataverse_org.js```
   
### Current Sphinx projects using this ("hackish") navbar:<commit_msg>updated sphinx directions<commit_after>## Dataverse.org Navbar for SPHINX projects                                                   

Instructions to add the 'dataverse.org' navbar to Sphinx projects.

The placement of the following files into a Sphinx project will result in a dynamically loading (JSONP) navbar matching that of http://dataverse.org*.  

(* currently http://beta.dataverse.org)

### Instructions:                                                                       

1. Create a blank Sphinx ```navbar.html``` file
    - file location: ```{{ your sphinx project }}/source/_templates/navbar.html```
    - example: ```best_practices/source/_templates/navbar.html```

1. Copy the contents of ```sphinx-navbar.html``` file into ```navbar.html```         
    - content source: ```sphinx-navbar.html```
    - content target: ```{{ your sphinx project }}/source/_templates/navbar.html```
        - example: ```best_practices/source/_templates/navbar.html```
    - ** In Guides.dataverse.org, the call to load "navbar_from_dataverse_org.js"  is different:
        - Usual call: ```<script type="text/javascript" src="/_static/navbar_from_dataverse_org.js"></script>```
        - For the guides: ```<script type="text/javascript" src="/en/4.0/_static/navbar_from_dataverse_org.js"></script>```

1. Copy the file ```navbar_from_dataverse_org.js``` to Sphinx
    - target location: ```{{ your sphinx project }}/source/_static/navbar_from_dataverse_org.js```
        - example: ```best_practices/source/_static/navbar_from_dataverse_org.js```
        
1. Run a build!  (take a break)


### Local testing

- Drag ```test_json_header.html`` into a browser
    - It should load the local ```navbar_from_dataverse_org.js``` file
    - The page will attempt to retrieve the navbar from the ```navbar_url``` specified in ```navbar_from_dataverse_org.js```
   
### Current Sphinx projects using this ("hackish") navbar:
{'fraction_non_alphanumeric': 0.1315940366972477, 'fraction_numerical': 0.0028669724770642203, 'mean_word_length': 2.9965635738831615, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2551164', 'n_tokens_mistral': 1037, 'n_tokens_neox': 992, 'n_words': 285}