Sphinx support (WIP)

README.md

@@ -36,4 +36,67 @@ Having trouble? Get help in the [Discussions](https://github.com/PostDocJS/postd
 ## Links
 
 - [License (MIT)](LICENSE)
-- [Website](https://postdoc.dev)
+- [Website](https://postdoc.dev)
+
+
+## Sphinx documentation
+
+Postdoc can handle sphinx documentation as well. 
+
+In your python project repository directory run the following CLI command:
+
+```shell
+sphinx-build -M xml ./docs/source ./docs/build/ -W --keep-going
+```
+
+**Important**: You sould be able to generate sphinx docs before running `postdoc init` command.
+
+On `postdoc init` command to handle the sphinx docs select the `sphinx-python` template and paste path to sphinx docs folder (where you have the Makefile and source folder).
+
+```
+? Select the UI template to used: sphinx-python
+? Enter path to python sphinx docs: absolute/path/to/sphinx/docs
+```
+
+**Something went wrong?**
+
+In case `sphinx-build` command failed, make sure the following applies to your python project as well.  
+
+Usually, setup for sphinx documentation has the following directory structure:
+
+```
+
+/docs: Main directory for Sphinx documentation. <---- we need this path!
+    /source: Your sphinx configuration and documentation in .md, .rst files.
+        conf.py: Config file for Sphinx
+        index.rst: Entrypoint for Sphinx docs (main page)
+        modules.rst: Lists the modules of your Python package.
+    /build: The output directory where Sphinx saves the generated documentation.
+    Makefile: A file with commands to build the docs in various formats.
+
+/your_python_package: The directory containing your Python package code.
+    __init__.py: Indicates that this directory is a Python package.
+    module1.py: A module in your package.
+    module2.py: Another module in your package.
+    setup.py: The setup script for installing the package.
+
+```
+
+TIP: If you get some imports errors make sure in the `conf.py` you added this code at the top:  
+
+```py
+# conf.py
+
+import sys
+
+absPathToPyPackage = __file__.split("docs")[0]
+
+sys.path.append(absPathToPyPackage)
+
+```
+
+With that change sphinx will be able to get doc strings from python classes and functions.
+
+
+
+

extra/templates/default/package.json

@@ -14,4 +14,4 @@
     "nightwatch": "${nightwatch_version}",
     "nightwatch-plugin-postdoc": "${nightwatch_plugin_postdoc_version}"
   }
-}
+}

extra/templates/default/postdoc.config.js

@@ -1,6 +1,8 @@
-import {sep} from 'node:path';
+import { sep } from 'node:path';
 
 export default {
+  template: 'default',
+
   pwa: {
     enabled: false
   },

extra/templates/sphinx-python/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "${project_name}",
+  "type": "module",
+  "version": "0.0.1",
+  "private": true,
+  "scripts": {
+    "test": "postdoc test",
+    "start": "postdoc run",
+    "build": "postdoc build",
+    "preview": "postdoc preview"
+  },
+  "devDependencies": {
+    "postdoc": "${postdoc_version}",
+    "nightwatch": "${nightwatch_version}",
+    "nightwatch-plugin-postdoc": "${nightwatch_plugin_postdoc_version}"
+  }
+}

extra/templates/sphinx-python/postdoc.config.js

@@ -0,0 +1,58 @@
+import { sep } from 'node:path';
+
+export default {
+  template: 'sphinx-python',
+  sphinx_docs_path: "${sphinx_docs_path}",
+
+  pwa: {
+    enabled: false
+  },
+
+  directories: {
+    content: './content',
+    tests: './test',
+    output: './out',
+    layouts: './src/layouts',
+    includes: './src/includes'
+  },
+
+  apidocs: {
+    tags: {},
+    source: null,
+    layout: 'apidocs.ejs',
+
+    createUrl(filePath) {
+      return filePath.split(sep).join('/').replace(/\.js$/, '.html');
+    }
+  },
+
+  ignore: {
+    pages: [],
+    apidocs: [],
+    layouts: []
+  },
+
+  logger: {
+    quiet: false,
+    noColors: false
+  },
+
+  nightwatch: {
+    headless: true,
+    browser: 'chrome',
+    watch: false,
+    parallel: false
+  },
+
+  appSettings: {},
+
+  markdown: {
+    extensions: [],
+    shikiOptions: {}
+  },
+
+  vite: {
+    publicDir: './src/public',
+    logLevel: 'silent'
+  }
+};