Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ exclude =
__pycache__,
build,
dist,
doc/source/conf.py
docs/source/conf.py
max-line-length = 115
# Ignore some style 'errors' produced while formatting by 'black'
# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#labels-why-pycodestyle-warnings
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ target/
.ipynb_checkpoints

# Auto sphinx docs
doc/source/collections/
docs/source/collections/
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ python:
- requirements: requirements/docs.txt

sphinx:
configuration: doc/source/conf.py
configuration: docs/source/conf.py
File renamed without changes.
72 changes: 36 additions & 36 deletions doc/make.bat → docs/make.bat
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=PackagingScientificPython
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end
popd
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=PackagingScientificPython

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ <h1 class="title">Regolith Commands</h1>
</span>validate<span class="whitespace"> </span>Validates<span class="whitespace"> </span>db
</pre>
<div class="system-message">
<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/huarundong/dbs/regolith/doc/source/commands/index.rst</tt>, line 38)</p>
<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/Users/huarundong/dbs/regolith/docs/source/commands/index.rst</tt>, line 38)</p>
<p>Unknown directive type &quot;toctree&quot;.</p>
<pre class="literal-block">
.. toctree::
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 1 addition & 2 deletions doc/source/conf.py → docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
# serve to show the default.

import json
import os
import sys
import tempfile
import time
Expand Down Expand Up @@ -154,7 +153,7 @@
"github_user": "regro",
"github_repo": "regolith",
"github_version": "main",
"conf_py_path": "/doc/source/",
"conf_py_path": "/docs/source/",
}

# Theme options are theme-specific and customize the look and feel of a theme
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
23 changes: 23 additions & 0 deletions news/talks-schema.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* <news item>

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* Added presenter and talk_id to the presentations schema

**Security:**

* <news item>
File renamed without changes.
2 changes: 2 additions & 0 deletions src/regolith/exemplars.json
Original file line number Diff line number Diff line change
Expand Up @@ -1631,13 +1631,15 @@
"institution": "columbiau",
"location": "Upton NY",
"meeting_name": "2018 NSLS-II and CFN Users Meeting",
"presenter": "sbillinge",
"notes": [
"We hope the weather will be sunny",
"if the weather is nice we will go to the beach"
],
"project": "18sob_clustermining",
"status": "accepted",
"title": "ClusterMining: extracting core structures of metallic nanoparticles from the atomic pair distribution function",
"talk_id": "30-graphite-rock",
"type": "poster"
},
{
Expand Down
10 changes: 10 additions & 0 deletions src/regolith/schemas.json
Original file line number Diff line number Diff line change
Expand Up @@ -1961,6 +1961,11 @@
"required": false,
"type": "string"
},
"presenter": {
"description": "The _id or name of the person making the presentation",
"required": false,
"type": "string"
},
"location": {
"description": "city and {state or country} of meeting",
"required": false,
Expand Down Expand Up @@ -1992,6 +1997,11 @@
"required": false,
"type": "string"
},
"talk_id": {
"description": "The id of the talk that will be presented",
"required": false,
"type": "string"
},
"title": {
"description": "title of the presentation",
"required": true,
Expand Down
2 changes: 2 additions & 0 deletions tests/outputs/a_presentation/presentations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,10 @@
notes:
- We hope the weather will be sunny
- if the weather is nice we will go to the beach
presenter: sbillinge
project: 18sob_clustermining
status: accepted
talk_id: 30-graphite-rock
title: 'ClusterMining: extracting core structures of metallic nanoparticles from
the atomic pair distribution function'
type: poster
Expand Down
Loading