[GitHub] spark issue #18702: [SPARK-21485][SQL][DOCS] Spark SQL documentation generat...

[HyukjinKwon]

Github user HyukjinKwon commented on the issue:

    https://github.com/apache/spark/pull/18702
  
    @srowen, so, the current structure is like ...
    
    ```
    .
    ├── docs
    └── sql
        ├── create-docs.sh      # Genenerates HTMLs.
        ├── gen-sql-markdown.py # Generaates markdown files.
        └── mkdocs.yml          # MkDocs configuration file.
    ```
    
    After `cd sql && create-docs.sh` under `sql`:
    
    ```
    .
    ├── docs
    └── sql
        ├── create-docs.sh
        ├── gen-sql-markdown.py
        ├── mkdocs.yml
        └── site                # Generated HTML files.
    ```
    
    After `cd docs && SKIP_SCALADOC=1 SKIP_PYTHONDOC=1 SKIP_RDOC=1 jekyll build`
    
    ```
    .
    ├── docs
    │   └── api
    │       └── sql
    │           └── site        # Copied from ./sql/site
    └── sql
        ├── create-docs.sh
        ├── gen-sql-markdown.py
        ├── mkdocs.yml
        └── site
    ```
    
    It is pretty easy to move files around in any case and I am fine with 
trying out to move multiple times to show how it looks like.
    
    So ... do you mean something like the one as below?
    
    ```
    .
    ├── docs
    └── sql
        ├── bin
        │  ├── create-docs.sh      # Genenerates HTMLs.
        │  └── gen-sql-markdown.py # Generaates markdown files.
        └── mkdocs.yml             # MkDocs configuration file.
    ```
    
    After `create-docs.sh` under `sql`:
    
    ```
    .
    ├── docs
    │   └── api
    │       └── sql
    │           └── site        # Generated HTML files.
    └── sql
        ├── bin
        │  ├── create-docs.sh
        │  └── gen-sql-markdown.py
        └── mkdocs.yml
    ```
    
    After `SKIP_SCALADOC=1 SKIP_PYTHONDOC=1 SKIP_RDOC=1 jekyll build`
    
    ```
    .
    ├── docs
    │   └── api
    │       └── sql
    │           └── site        # Generated HTML files.
    └── sql
        ├── bin
        │  ├── create-docs.sh
        │  └── gen-sql-markdown.py
        └── mkdocs.yml
    ```
    
    Or, would this maybe give you another idea?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org