Skip to main content

​
Managing rules

Sphinx supports two types of rules, with differing levels of scope and setup:
TypeScopeDescriptionLocation
User RulesUser-specificRules that apply to every project across all platformsDashboard → Rules
SPHINX.mdUser-specific, per platformProject-specific rules defined in a markdown fileSPHINX.md file in your workspace
All rules are combined and applied together. When there are conflicts, more specific rules take precedence.

​
User Rules

User Rules can be configured directly in the dashboard, under the “Rules” page:
Empty rules page in Sphinx dashboard
Once User Rules are created, they will automatically apply across all platforms (VS Code Extension, CLI, Horus) and can be updated:
Rules page showing edit and delete options

​
SPHINX.md

SPHINX.md files let you add custom instructions per project. For every notebook, Sphinx will start in your current folder and check each parent until it finds the closest SPHINX.md file. Example SPHINX.md: 
# Customer Analytics Project

## Notebook Style
- Put data quality checks at the top of every analysis notebook
- Include sample size (n=X) in all chart titles

## Analysis
- Use plotly for stakeholder charts
- Avoid the default train_test_split - we have time-based splitting in utils.py
You can also create a SPHINX.md file in the VS Code Extension and Horus through the sidebar:
Sphinx sidebar showing option to create SPHINX.md file